diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/devops/2021-06-25 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/devops/2021-06-25')
| -rw-r--r-- | data/zh_cn/devops/2021-06-25/api-docs.php | 52824 |
1 files changed, 52824 insertions, 0 deletions
diff --git a/data/zh_cn/devops/2021-06-25/api-docs.php b/data/zh_cn/devops/2021-06-25/api-docs.php new file mode 100644 index 0000000..dcf7578 --- /dev/null +++ b/data/zh_cn/devops/2021-06-25/api-docs.php @@ -0,0 +1,52824 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'devops', + 'version' => '2021-06-25', + ], + 'directories' => [ + [ + 'id' => 164546, + 'title' => '代码管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 172780, + 'title' => '文件', + 'type' => 'directory', + 'children' => [ + 'CreateFile', + 'DeleteFile', + 'UpdateFile', + 'GetFileBlobs', + 'ListRepositoryTree', + ], + ], + [ + 'id' => 164547, + 'title' => '提交', + 'type' => 'directory', + 'children' => [ + 'GetFileLastCommit', + 'GetRepositoryCommit', + 'ListRepositoryCommits', + 'ListRepositoryCommitDiff', + 'CreateCommitWithMultipleFiles', + ], + ], + [ + 'id' => 164551, + 'title' => '成员', + 'type' => 'directory', + 'children' => [ + 'AddRepositoryMember', + 'AddGroupMember', + 'DeleteRepositoryMember', + 'DeleteGroupMember', + 'UpdateRepositoryMember', + 'UpdateGroupMember', + 'ListRepositoryMemberWithInherited', + 'GetProjectMember', + 'ListGroupMember', + ], + ], + [ + 'id' => 164554, + 'title' => '仓库', + 'type' => 'directory', + 'children' => [ + 'CreateRepository', + 'DeleteRepository', + 'UpdateRepository', + 'TriggerRepositoryMirrorSync', + 'TransferRepository', + 'ListRepositories', + 'GetRepository', + ], + ], + [ + 'id' => 171910, + 'title' => '分支', + 'type' => 'directory', + 'children' => [ + 'CreateBranch', + 'CreateProtectdBranch', + 'DeleteBranch', + 'DeleteProtectedBranch', + 'UpdateProtectedBranches', + 'GetBranchInfo', + 'ListRepositoryBranches', + 'ListProtectedBranches', + ], + ], + [ + 'id' => 185321, + 'title' => '合并请求', + 'type' => 'directory', + 'children' => [ + 'GetMergeRequest', + 'ListMergeRequests', + 'CreateMergeRequest', + 'UpdateMergeRequest', + 'UpdateMergeRequestPersonnel', + 'MergeMergeRequest', + 'ReviewMergeRequest', + 'CloseMergeRequest', + 'ReopenMergeRequest', + 'ListMergeRequestPatchSets', + 'GetMergeRequestChangeTree', + 'ListMergeRequestFilesReads', + 'ListMergeRequestComments', + 'CreateComment', + ], + ], + [ + 'id' => 178462, + 'title' => '比较', + 'type' => 'directory', + 'children' => [ + 'GetCompareDetail', + ], + ], + [ + 'id' => 187893, + 'title' => '提交状态', + 'type' => 'directory', + 'children' => [ + 'CreateCommitStatus', + 'ListCommitStatuses', + ], + ], + [ + 'id' => 189204, + 'title' => '检查运行', + 'type' => 'directory', + 'children' => [ + 'CreateCheckRun', + 'UpdateCheckRun', + 'GetCheckRun', + 'ListCheckRuns', + ], + ], + [ + 'id' => 177752, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'CreateTag', + 'DeleteTag', + 'GetRepositoryTag', + 'ListRepositoryTags', + ], + ], + [ + 'id' => 188973, + 'title' => '类标', + 'type' => 'directory', + 'children' => [ + 'CreateProjectLabel', + 'UpdateProjectLabel', + 'DeleteProjectLabel', + 'ListProjectLabels', + 'ListMergeRequestLabels', + 'LinkMergeRequestLabel', + ], + ], + [ + 'id' => 164559, + 'title' => 'Webhook', + 'type' => 'directory', + 'children' => [ + 'AddWebhook', + 'DeleteRepositoryWebhook', + 'ListRepositoryWebhook', + ], + ], + [ + 'id' => 176819, + 'title' => '代码组', + 'type' => 'directory', + 'children' => [ + 'CreateRepositoryGroup', + 'DeleteRepositoryGroup', + 'UpdateGroup', + 'GetGroupDetail', + 'GetGroupByPath', + 'ListRepositoryGroups', + 'ListGroupRepositories', + ], + ], + [ + 'id' => 178460, + 'title' => '推送评审', + 'type' => 'directory', + 'children' => [ + 'UpdatePushReviewOnOff', + ], + ], + [ + 'id' => 186377, + 'title' => '推送规则', + 'type' => 'directory', + 'children' => [ + 'CreatePushRule', + 'UpdatePushRule', + 'DeletePushRule', + 'ListPushRules', + ], + ], + [ + 'id' => 177915, + 'title' => '部署密钥', + 'type' => 'directory', + 'children' => [ + 'CreateDeployKey', + 'EnableDeployKey', + ], + ], + [ + 'id' => 183443, + 'title' => 'SSH密钥', + 'type' => 'directory', + 'children' => [ + 'CreateUserKey', + 'DeleteUserKey', + 'ListUserKeys', + ], + ], + [ + 'id' => 178455, + 'title' => '代码搜索', + 'type' => 'directory', + 'children' => [ + 'ListSearchSourceCode', + 'ListSearchRepository', + 'ListSearchCommit', + 'GetSearchCodePreview', + ], + ], + [ + 'id' => 164549, + 'title' => '企业信息', + 'type' => 'directory', + 'children' => [ + 'GetCodeupOrganization', + 'ListOrganizations', + ], + ], + [ + 'id' => 177750, + 'title' => '用户', + 'type' => 'directory', + 'children' => [ + 'GetUserInfo', + ], + ], + [ + 'id' => 184606, + 'title' => '审计', + 'type' => 'directory', + 'children' => [ + 'ListUserResources', + ], + ], + [ + 'id' => 167604, + 'title' => '鉴权', + 'type' => 'directory', + 'children' => [ + 'CreateOAuthToken', + ], + ], + ], + ], + [ + 'id' => 129795, + 'title' => '流水线', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 184754, + 'title' => '服务连接', + 'type' => 'directory', + 'children' => [ + 'CreateServiceConnection', + 'CreateServiceAuth', + 'CreateServiceCredential', + 'ListServiceCredentials', + 'ListServiceAuths', + 'ListServiceConnections', + ], + ], + [ + 'id' => 169998, + 'title' => '主机部署', + 'type' => 'directory', + 'children' => [ + 'StopVMDeployOrder', + 'SkipVMDeployMachine', + 'RetryVMDeployMachine', + 'ResumeVMDeployOrder', + 'GetVMDeployOrder', + 'LogVMDeployMachine', + ], + ], + [ + 'id' => 169999, + 'title' => '流水线分组', + 'type' => 'directory', + 'children' => [ + 'CreatePipelineGroup', + 'DeletePipelineGroup', + 'JoinPipelineGroup', + 'UpdatePipelineGroup', + 'GetPipelineGroup', + 'ListPipelineGroupPipelines', + 'ListPipelineGroups', + ], + ], + [ + 'id' => 129796, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'CreateFlowTag', + 'CreateFlowTagGroup', + 'DeleteFlowTagGroup', + 'DeleteFlowTag', + 'UpdateFlowTag', + 'UpdateFlowTagGroup', + 'GetFlowTagGroup', + 'ListFlowTagGroups', + ], + ], + [ + 'id' => 129805, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateSshKey', + 'ResetSshKey', + ], + ], + [ + 'id' => 129809, + 'title' => '成员', + 'type' => 'directory', + 'children' => [ + 'CreateResourceMember', + 'DeleteResourceMember', + 'UpdateResourceMember', + 'ListResourceMembers', + ], + ], + [ + 'id' => 129814, + 'title' => '主机组', + 'type' => 'directory', + 'children' => [ + 'CreateHostGroup', + 'DeleteHostGroup', + 'UpdateHostGroup', + 'GetHostGroup', + 'ListHostGroups', + ], + ], + [ + 'id' => 129820, + 'title' => '变量组', + 'type' => 'directory', + 'children' => [ + 'CreateVariableGroup', + 'DeleteVariableGroup', + 'UpdateVariableGroup', + 'GetVariableGroup', + 'ListVariableGroups', + ], + ], + [ + 'id' => 129826, + 'title' => '流水线', + 'type' => 'directory', + 'children' => [ + 'CreatePipeline', + 'DeletePipeline', + 'DeletePipelineRelations', + 'UpdatePipeline', + 'StartPipelineRun', + 'StopPipelineJobRun', + 'StopPipelineRun', + 'UpdatePipelineBaseInfo', + 'RetryPipelineJobRun', + 'SkipPipelineJobRun', + 'PassPipelineValidate', + 'RefusePipelineValidate', + 'AddPipelineRelations', + 'GetPipeline', + 'GetPipelineRun', + 'ListPipelineRuns', + 'ListPipelines', + 'GetPipelineArtifactUrl', + 'GetPipelineEmasArtifactUrl', + 'GetPipelineScanReportUrl', + 'ListPipelineJobHistorys', + 'ListPipelineJobs', + 'LogPipelineJobRun', + 'ListPipelineRelations', + ], + ], + ], + ], + [ + 'id' => 129766, + 'title' => '项目管理（Projex）', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 129767, + 'title' => '工作项', + 'type' => 'directory', + 'children' => [ + 'WorkitemAttachmentCreate', + 'ListWorkitemAttachments', + 'CreateWorkitemV2', + 'CreateWorkitemRecord', + 'CreateWorkitem', + 'CreateWorkitemComment', + 'DeleteWorkitemComment', + 'DeleteWorkitemAllComment', + 'UpdateWorkitemComment', + 'UpdateWorkItem', + 'GetWorkitemAttachmentCreatemeta', + 'GetWorkitemTimeTypeList', + 'GetWorkitemRelations', + 'GetWorkitemCommentList', + 'CreateWorkitemEstimate', + 'GetCustomFieldOption', + 'GetWorkItemActivity', + 'GetWorkItemInfo', + 'GetWorkItemWorkFlowInfo', + 'ListProjectWorkitemTypes', + 'ListWorkItemAllFields', + 'ListWorkItemWorkFlowStatus', + 'ListWorkitems', + 'ListWorkitemTime', + 'ListWorkitemEstimate', + 'UpdateWorkitemField', + 'DeleteWorkitem', + 'GetWorkitemFile', + ], + ], + [ + 'id' => 129777, + 'title' => '项目', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'CreateSprint', + 'DeleteProject', + 'UpdateProjectMember', + 'UpdateProjectField', + 'GetProjectInfo', + 'ListProjectMembers', + 'GetSprintInfo', + 'ListProjects', + 'ListProjectTemplates', + 'ListSprints', + ], + ], + ], + ], + [ + 'id' => 183317, + 'title' => '测试管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 183318, + 'title' => '测试用例库', + 'type' => 'directory', + 'children' => [ + 'CreateTestCase', + 'UpdateTestCase', + 'ListTestCaseFields', + 'GetTestcaseList', + ], + ], + [ + 'id' => 183322, + 'title' => '测试计划', + 'type' => 'directory', + 'children' => [ + 'UpdateTestResult', + 'GetTestResultList', + ], + ], + ], + ], + [ + 'id' => 192620, + 'title' => '效能洞察', + 'type' => 'directory', + 'children' => [ + 'ExportWorkitemActivity', + 'ExportInsightWorkitemVersion', + 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra', + 'ExportInsightWorkitemStatus', + 'ExportInsightWorkTime', + 'ExportInsightTagRef', + 'ExportInsightSprint', + 'ExportInsightSpaceRef', + 'ExportInsightSpace', + 'ExportInsightField', + 'ExportInsightExpectedWorkTime', + 'ExportInsightCustomValue', + ], + ], + [ + 'id' => 129762, + 'title' => '企业和成员', + 'type' => 'directory', + 'children' => [ + 'UpdateOrganizationMember', + 'ListOrganizationMembers', + 'GetOrganizationMember', + 'ListJoinedOrganizations', + ], + ], + [ + 'id' => 188636, + 'title' => '应用交付', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 188637, + 'title' => '应用', + 'type' => 'directory', + 'children' => [ + 'GetApplication', + 'UpdateApplication', + 'ListApplications', + ], + ], + [ + 'id' => 193448, + 'title' => '应用成员', + 'type' => 'directory', + 'children' => [ + 'ListApplicationMembers', + 'CreateAppMembers', + 'UpdateAppMember', + 'DeleteAppMember', + ], + ], + [ + 'id' => 193449, + 'title' => '应用研发流程', + 'type' => 'directory', + 'children' => [ + 'GetReleaseStagePipelineRun', + 'ExecuteChangeRequestReleaseStage', + 'CancelExecutionReleaseStage', + 'ListAllReleaseWorkflows', + 'ListAppReleaseStageExecutions', + 'ListAppReleaseStageExecutionIntegratedMetadata', + 'RefuseReleaseStagePipelineValidate', + 'PassReleaseStagePipelineValidate', + ], + ], + [ + 'id' => 193927, + 'title' => '变更', + 'type' => 'directory', + 'children' => [ + 'CreateChangeRequest', + 'ListChangeRequests', + 'ListChangeRequestWorkflowExecutions', + ], + ], + ], + ], + [ + 'id' => 196435, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListUserDrawRecordByPk', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateFile' => [ + 'summary' => '创建代码库文件。', + 'path' => '/repository/{repositoryId}/files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求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' => '编码方式'."\n" + .'可选：text / base64，默认值为text', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'content' => [ + 'description' => '文件内容', + 'type' => 'string', + 'required' => true, + 'example' => '文件内容', + ], + 'commitMessage' => [ + 'description' => '创建文件时的提交信息', + 'type' => 'string', + 'required' => true, + 'example' => '创建xxx文件', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F8053E32-9623-511F-8B46-F0E5FD206524', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'filePath' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => '/src/main/test.java', + ], + 'branchName' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F8053E32-9623-511F-8B46-F0E5FD206524\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"filePath\\": \\"/src/main/test.java\\",\\n \\"branchName\\": \\"master\\"\\n }\\n}","type":"json"}]', + 'title' => '创建文件', + ], + 'DeleteFile' => [ + 'summary' => '删除代码库指定文件。', + 'path' => '/repository/{repositoryId}/files/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/test.java', + ], + ], + [ + 'name' => 'commitMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '删除文件时的提交信息', + 'type' => 'string', + 'required' => true, + 'example' => '删除当前文件', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '7EFAD5FB-2296-5D52-BC60-FCC992A40767', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'filePath' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'src/main/delete.java', + ], + 'branchName' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7EFAD5FB-2296-5D52-BC60-FCC992A40767\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"filePath\\": \\"src/main/delete.java\\",\\n \\"branchName\\": \\"master\\"\\n }\\n}","type":"json"}]', + 'title' => '删除文件', + ], + 'UpdateFile' => [ + 'summary' => '修改代码库某个文件。', + 'path' => '/repository/{repositoryId}/files/update', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'string', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + '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' => '编码方式'."\n" + .'可选：text / base64，默认值为text', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'content' => [ + 'description' => '文件内容', + 'type' => 'string', + 'required' => true, + 'example' => '修改文件的内容', + ], + 'commitMessage' => [ + 'description' => '更新文件时的提交信息', + 'type' => 'string', + 'required' => true, + 'example' => '修改update.txt文件内容', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + 'filePath' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'src/main/update.txt', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"branchName\\": \\"master\\",\\n \\"filePath\\": \\"src/main/update.txt\\"\\n }\\n}","type":"json"}]', + 'title' => '修改文件', + ], + 'GetFileBlobs' => [ + 'summary' => '查询代码库某个文件的具体内容。', + 'path' => '/repository/{repositoryId}/files/blobs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2744800', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => true, + 'example' => 'src/Test.java', + ], + ], + [ + 'name' => 'ref', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称、标签名称或者提交的版本号', + 'type' => 'string', + 'required' => true, + 'example' => 'master / tag1.0 / ecykhdd', + ], + ], + [ + 'name' => 'from', + 'in' => 'query', + 'schema' => [ + 'description' => '文件开始行，若为空，则取文件全部内容', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => [ + 'description' => '文件结束行，且只有在from不为空时才有意义', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '文件内容', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'totalLines' => [ + 'description' => '文件总行数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65535', + ], + 'size' => [ + 'description' => '文件内容大小，单位：bytes', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"content\\": \\"xxxx\\",\\n \\"totalLines\\": 65535,\\n \\"size\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询文件内容', + ], + 'ListRepositoryTree' => [ + 'summary' => '查询代码库的文件树。', + 'path' => '/repository/{repositoryId}/files/tree', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '624666bd54d036291ae13a36', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2851516', + ], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => [ + 'description' => '代码仓库内的文件路径，获取该路径下的文件目录，默认获取代码库文件树的全部结构', + 'type' => 'string', + 'required' => false, + 'example' => 'module', + ], + ], + [ + 'name' => 'refName', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称、标签名称或CommitID，默认为代码库库默认分支', + 'type' => 'string', + 'required' => false, + 'example' => 'master / tag1.0 / sjjfssa', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '查找策略'."\n" + .'DIRECT：仅展示当前目录下的内容'."\n" + .'RECURSIVE：递归查找当前路径下的所有文件'."\n" + .'FLATTEN：扁平化展示（如果是目录，递归查找，直到子目录包含文件或多个目录为止）', + 'type' => 'string', + 'required' => false, + 'example' => 'RECURSIVE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '文件类型'."\n" + .'tree: 目录'."\n" + .'blob：文件'."\n" + .'commit：commit支持submodule', + 'type' => 'string', + 'example' => 'blob', + ], + 'mode' => [ + 'description' => '类型、权限信息', + 'type' => 'string', + 'example' => '100644', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6557983C-FB08-51A9-AC5A-A7A0D0950A07\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"path\\": \\"test-codeup\\",\\n \\"isLFS\\": false,\\n \\"id\\": \\"76c3f251f414ac31f2e01faf6f2008a9d756a437\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"type\\": \\"blob\\",\\n \\"mode\\": \\"100644\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询文件树', + ], + 'GetFileLastCommit' => [ + 'summary' => '查询指定文件的最近一次Git提交。', + 'path' => '/repository/{repositoryId}/files/lastCommit', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '个人访问令牌', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2825387', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '云效企业ID', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'title' => '分支名称、标签名称或Commit ID', + 'description' => '分支名称、标签名称或Commit ID'."\n" + .'例如：'."\n" + .'分支名称：master'."\n" + .'标签名称：tag001'."\n" + .'CommitID：ff4fb5ac6d1f44f452654336d2dba468ae6c8d04', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'title' => '文件路径', + 'description' => '文件路径', + 'type' => 'string', + 'required' => true, + 'example' => 'src/main/test.java', + ], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => [ + 'description' => '展示签名，默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'title' => '请求结果', + 'description' => '请求结果', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'result' => [ + 'title' => '响应结果', + 'description' => '响应结果', + 'type' => 'object', + 'properties' => [ + 'shortId' => [ + 'title' => 'Commit短ID', + 'description' => '短ID', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'authorName' => [ + 'title' => '作者姓名', + 'description' => '作者姓名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorDate' => [ + 'title' => '作者提交时间', + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-08-08 18:09:09', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'title' => '提交内容', + 'description' => '提交内容', + 'type' => 'string', + 'example' => '提交的具体内容', + ], + 'title' => [ + 'title' => '标题，提交的第一行内容', + 'description' => '标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'committerName' => [ + 'title' => '提交者姓名', + 'description' => '提交者姓名', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'authorEmail' => [ + 'title' => '提交者邮箱', + 'description' => '提交者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'title' => 'Commit ID', + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + 'committerEmail' => [ + 'title' => '提交者邮箱', + 'description' => '提交者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'title' => '提交者提交时间', + 'description' => '提交者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 15:00:02', + ], + 'parentIds' => [ + 'title' => '父提交ID', + 'description' => '父提交ID', + 'type' => 'array', + 'items' => [ + 'title' => '父提交Id', + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'signature' => [ + 'title' => '签名', + 'description' => '签名', + 'type' => 'object', + 'properties' => [ + 'verificationStatus' => [ + 'title' => '验证状态', + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + 'gpgKeyId' => [ + 'title' => 'GPG密钥ID', + 'description' => 'GPG密钥ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"result\\": {\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorDate\\": \\"2022-08-08 18:09:09\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"提交的具体内容\\",\\n \\"title\\": \\"提交标题\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 15:00:02\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"signature\\": {\\n \\"verificationStatus\\": \\"verified\\",\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetFileLastCommitResponse>\\n <ErrorMessage>An error occurred while processing your request.\\t\\n</ErrorMessage>\\n <RequestId>AB270BBA-EFB1-5773-B3DC-07CD036F7352</RequestId>\\n <Success>true</Success>\\n <ErrorCode>SYSTEM_UNKNOWN_ERROR</ErrorCode>\\n <Result>\\n <ShortId>231d5bc453d</ShortId>\\n <AuthorName>阿里云云效</AuthorName>\\n <AuthorDate>2022-03-18 10:00:00</AuthorDate>\\n <CreatedAt>2022-03-18 10:00:00</CreatedAt>\\n <Message>测试云效Codeup</Message>\\n <Title>Test 云效 Codeup Commit</Title>\\n <CommitterName>阿里云云效Codeup</CommitterName>\\n <AuthorEmail>[email protected]</AuthorEmail>\\n <Id>201</Id>\\n <CommitterEmail>[email protected]</CommitterEmail>\\n <CommittedDate>2022-03-18 10:00:00\\n</CommittedDate>\\n <ParentIds>34d2c47c7ce46a5c4639c5ffe208a66dda975a05</ParentIds>\\n <Signature>\\n <VerificationStatus>VERIFIED</VerificationStatus>\\n <GpgKeyId>34d2c47c7ce46a5c4639c5ffe208</GpgKeyId>\\n </Signature>\\n </Result>\\n</GetFileLastCommitResponse>","errorExample":""}]', + 'title' => '查询文件最近一次提交信息', + ], + 'GetRepositoryCommit' => [ + 'summary' => '查询代码库的单个提交信息。', + 'path' => '/repository/{repositoryId}/commits/{sha}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => 'The ID of a project', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'sha', + 'in' => 'path', + 'schema' => [ + 'title' => 'The commit hash or name of a repository branch or tag', + 'description' => '分支名称、标签名称或Commit ID', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'showSignature', + 'in' => 'query', + 'schema' => [ + 'title' => '展示签名', + 'description' => '展示签名'."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID（Hash串）', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + 'shortId' => [ + 'description' => '简短的提交ID '."\n" + .'例如： '."\n" + .'CommitID：ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 '."\n" + .'ShortId：ff4fb5ac', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '云效Codeup提交Title', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '具体的提交内容', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 15:00:02', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'test-nickname', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '提交者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '签名信息', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => 'gpg签名的key id', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208', + ], + 'verificationStatus' => [ + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '评论数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\",\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"title\\": \\"云效Codeup提交Title\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 15:00:02\\",\\n \\"committerEmail\\": \\"[email protected]\\\\n\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 24661,\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"34d2c47c7ce46a5c4639c5ffe208\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询代码库提交信息', + ], + 'ListRepositoryCommits' => [ + 'summary' => '查询代码库的提交历史信息，支持滚动分页。', + 'path' => '/repository/{repositoryId}/commits', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'refName', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称、标签名称或CommitID，默认为代码库库默认分支', + 'type' => 'string', + 'required' => true, + 'example' => 'master 或 tag1.0或 sjjfssa', + ], + ], + [ + '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' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + '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' => '展示签名'."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'showCommentsCount', + 'in' => 'query', + 'schema' => [ + 'description' => '展示评论数量'."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '总记录数'."\n" + ."\n" + .'><notice>提交列表采用的是滚动分页，可做参考，不能作为准确的信息。></notice>', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '简短的提交ID '."\n" + .'例如： '."\n" + .'CommitID：ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 '."\n" + .'ShortId：ff4fb5ac', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '提交的具体内容', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 16:00:00', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7914', + ], + 'name' => [ + 'description' => '用户姓名', + 'type' => 'string', + 'example' => '云效', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => '头像地址'."\n" + ."\n" + .'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '提交者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41031', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'nickname', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '签名信息', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => 'gpg签名的key id', + 'type' => 'string', + 'example' => '”“', + ], + 'verificationStatus' => [ + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '评论数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F1138237-CF7F-56BF-95D4-9AA937CCE8E5\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"OpenApi.error\\",\\n \\"success\\": true,\\n \\"total\\": 145,\\n \\"result\\": [\\n {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"message\\": \\"提交的具体内容\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 16:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"parentIds\\": [\\n \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\"\\n ],\\n \\"author\\": {\\n \\"id\\": 7914,\\n \\"name\\": \\"云效\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"头像地址\\\\n\\\\nhttps://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 41031,\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"”“\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询代码库提交列表', + ], + 'ListRepositoryCommitDiff' => [ + 'summary' => '根据代码库ID（repositoryId）和SHA值（sha），可选上下文行数参数（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' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'sha', + 'in' => 'path', + 'schema' => [ + 'description' => '分支名称、标签名称或Commit ID'."\n" + .'例如：'."\n" + .'分支名称：master'."\n" + .'标签名称：tag001'."\n" + .'CommitID：ff4fb5ac6d1f44f452654336d2dba468ae6c8d04'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + [ + 'name' => 'contextLine', + 'in' => 'query', + 'schema' => [ + 'description' => '上下文行数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'AB270BBA-EFB1-5773-B3DC-07CD036F7352', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '响应结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回详情结果'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'oldId' => [ + 'description' => '旧文件的git object id', + 'type' => 'string', + 'example' => '0000000000000000000000000000000000000000', + ], + 'newId' => [ + 'description' => '新文件的git object id', + 'type' => 'string', + 'example' => '6c268061a546378276559c713d0ad377d4dsjfh', + ], + 'isNewLfs' => [ + 'description' => '新文件是否是大文件（LFS）', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isOldLfs' => [ + 'description' => '旧文件是否是大文件（LFS）', + 'type' => 'boolean', + 'example' => 'true', + ], + 'diff' => [ + 'description' => 'diff内容', + 'type' => 'string', + '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', + ], + 'newPath' => [ + 'description' => '新文件路径', + 'type' => 'string', + 'example' => 'src/test/java/com/aliyun/codeupdemo/CodeupDemoApplicationTests.java', + ], + 'oldPath' => [ + 'description' => '旧文件路径', + 'type' => 'string', + 'example' => 'src/test/java/com/aliyun/codeupExample/CodeupDemoApplicationTests.java', + ], + 'aMode' => [ + 'description' => '旧的文件模式标识，包含文件类型、权限等信息', + 'type' => 'string', + 'example' => '100644', + ], + 'bMode' => [ + 'description' => '新的文件模式标识，包含文件类型、权限等信息', + 'type' => 'string', + 'example' => '100755', + ], + 'newFile' => [ + 'description' => '是否是新增文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'renamedFile' => [ + 'description' => '是否是重命名文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deletedFile' => [ + 'description' => '是否是删除文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isBinary' => [ + 'description' => '是否二进制文件', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + 'title' => '查询代码库单个提交的提交内容', + 'description' => '代码库ID：repositoryId，SHA值（sha）为必填项。其中，SHA值代表分支名称、标签名称或Commit ID。', + ], + 'CreateCommitWithMultipleFiles' => [ + 'summary' => '创建一个提交，并能够变更多个文件。一般在日常开发中，一个提交通常会有多个文件变动，当前API就是应用于该情况。', + 'path' => '/api/v4/projects/repository/commits/files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'description' => '代码分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'commitMessage' => [ + 'description' => '提交说明信息', + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + 'actions' => [ + 'description' => '操作数组，每个action代表一个文件的操作', + 'type' => 'array', + 'items' => [ + 'description' => '操作信息', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'description' => '操作类型'."\n" + ."\n" + .'- create：创建文件'."\n" + .'- delete：删除文件'."\n" + .'- move：移动文件'."\n" + .'- update：更新文件', + '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' => '文件内容'."\n" + ."\n" + .'><notice>若是更新操作，则是完全覆盖，即传入的content内容，会直接覆盖原有的文件内容></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'errorMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'result' => [ + 'description' => '返回结果'."\n" + ."\n\n" + .'> 当前API返回的结果为提交信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交'."\r".'ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => 'Commit短ID', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '具体的提交内容', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 15:00:00', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 16:00:00', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 ', + ], + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '1234567890', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + 'committer' => [ + 'description' => '提交者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '1234567890', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'committer-codeup', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + ."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'websiteUrl' => [ + 'description' => '用户个人网页地址', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"result\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 15:00:00\\",\\n \\"committerName\\": \\"committer-codeup\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 16:00:00\\",\\n \\"parentIds\\": [\\n \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 \\"\\n ],\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"aliyunPk\\": \\"1234567890\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 24661,\\n \\"aliyunPk\\": \\"1234567890\\",\\n \\"name\\": \\"committer-codeup\\",\\n \\"username\\": \\"committer-codeup\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '多文件变更提交', + ], + 'AddRepositoryMember' => [ + 'summary' => '增加代码库成员，以阿里云账号ID（aliyunPk）作为标识，支持以阿里云账号ID批量添加成员（aliyunPks以逗号作为分隔符号）。', + 'path' => '/repository/{repositoryId}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '代码库ID', + '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' => '需要添加为代码库成员的用户阿里云ID。支持多个，以","分割', + 'type' => 'string', + 'required' => true, + 'example' => '18745637472884', + ], + 'accessLevel' => [ + 'title' => '成员权限', + 'description' => '成员权限', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'Codeup访问令牌，使用AK/SK方式访问可以不用填AccessToken', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + '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' => '请求ID', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'success' => [ + 'title' => '请求状态', + 'description' => '请求状态', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'title' => '返回结果', + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果对象', + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'title' => '邮箱', + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatarUrl' => [ + 'title' => '头像地址', + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'state' => [ + 'title' => '状态', + 'description' => '状态 '."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'accessLevel' => [ + 'title' => '权限类型', + 'description' => '权限类型'."\n" + .'- 20-浏览者'."\n" + .'- 30-开发者'."\n" + .'- 40-管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'id' => [ + 'title' => 'Codeup用户Id', + 'description' => 'Codeup用户Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"state\\": \\"active\\",\\n \\"accessLevel\\": 40,\\n \\"id\\": 123456\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<AddRepositoryMemberResponse>\\n <ErrorMessage>SYSTEM_NOT_FOUND_ERROR</ErrorMessage>\\n <RequestId>6177543A-8D54-5736-A93B-E0195A1512CB</RequestId>\\n <ErrorCode>404</ErrorCode>\\n <Success>true</Success>\\n <Result>\\n <ExternUserId>ea18szad13r42</ExternUserId>\\n <Email>[email protected]</Email>\\n <AvatarUrl>\\"\\"</AvatarUrl>\\n <State>active</State>\\n <AccessLevel>30</AccessLevel>\\n <Id>13</Id>\\n </Result>\\n</AddRepositoryMemberResponse>","errorExample":""}]', + 'title' => '增加代码库成员', + ], + 'AddGroupMember' => [ + 'summary' => '添加代码组的成员。', + 'path' => '/repository/groups/{groupId}/members/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'aliyunPks' => [ + 'description' => '组成员的阿里云账号ID。支持多个，以","分割', + 'type' => 'string', + 'required' => true, + 'example' => '18745637472884', + ], + 'accessLevel' => [ + 'description' => '成员权限'."\n" + .'- 20：浏览者 '."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果列表（可能添加多个成员）', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '状态 '."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '成员权限'."\n" + .'- 20：浏览者'."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'sourceId' => [ + 'description' => '来源ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 123456,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + 'title' => '添加组成员', + ], + 'DeleteRepositoryMember' => [ + 'summary' => '根据阿里云账号ID来移除某个指定的代码库成员。', + 'path' => '/repository/{repositoryId}/members/delete/{aliyunPk}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080398', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'memberType' => [ + 'description' => '成员类型'."\n" + .'TEAMS：部门'."\n" + .'USERS：员工', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0E1BCF81-51E6-59D4-8D55-FF945111127A', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '主键，无业务意义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'createAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'updateAt' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'sourceId' => [ + 'description' => '来源ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2080398', + ], + 'sourceType' => [ + 'description' => '关联源的类型'."\n" + .'可选值：Project / Namespace', + 'type' => 'string', + 'example' => 'Project', + ], + 'userId' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19280', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20：浏览者 '."\n" + .'30：开发者'."\n" + .'40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0E1BCF81-51E6-59D4-8D55-FF945111127A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"createAt\\": \\"2022-03-12 12:00:00\\",\\n \\"updateAt\\": \\"2022-03-12 12:00:00\\",\\n \\"sourceId\\": 2080398,\\n \\"sourceType\\": \\"Project\\",\\n \\"userId\\": 19280,\\n \\"accessLevel\\": 30\\n }\\n}","type":"json"}]', + 'title' => '删除代码库成员', + ], + 'DeleteGroupMember' => [ + 'summary' => '根据阿里云账号ID来删除指定代码组下的某个成员。', + 'path' => '/repository/groups/{groupId}/members/remove/aliyun_pk', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '6082a9b0c7972588ac363793', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34410', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '组成员的阿里云账号ID', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'memberType' => [ + 'description' => '成员类型，填写默认值：USERS', + 'type' => 'string', + 'required' => true, + 'example' => 'USERS', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '状态 '."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20：浏览者 '."\n" + .'30：开发者'."\n" + .'40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'memberType' => [ + 'description' => '成员类型，默认值：USERS', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '关联的ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2080398', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"accessLevel\\": 40,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 2080398\\n }\\n}","type":"json"}]', + 'title' => '删除组成员', + ], + 'UpdateRepositoryMember' => [ + 'summary' => '根据代码库ID（repositoryId）、用户ID（userId）以及更新内容，更改当前代码库下对应成员的权限或角色。'."\n" + .'注意：后续会将用户ID统一为阿里云账号ID（aliyunPk），请注意关注。', + 'path' => '/repository/{repositoryId}/members/{aliyunPk}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => true, + 'example' => '1232456789123467', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求入参', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20-浏览者'."\n" + .'30-开发者'."\n" + .'40-管理员'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'expireAt' => [ + 'description' => '任务过期时间', + 'type' => 'string', + 'required' => false, + 'example' => '2020-08-08 08:08:08', + ], + 'memberType' => [ + 'description' => '成员类型'."\n" + .'TEAMS - 部门'."\n" + .'USERS - 员工', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + 'relatedId' => [ + 'description' => '关联ID', + 'type' => 'string', + 'required' => false, + 'example' => '10010', + ], + 'relatedInfos' => [ + 'description' => '待修改的目标仓库信息', + 'type' => 'array', + 'items' => [ + 'description' => '具体信息', + 'type' => 'object', + 'properties' => [ + 'relatedId' => [ + 'description' => '关联id', + 'type' => 'string', + 'required' => false, + 'example' => '10011', + ], + 'sourceId' => [ + 'description' => '关联sourceId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '24790', + ], + 'sourceType' => [ + 'description' => '关联sourceType'."\n" + .'可选值：Project / Namespace / Organization', + 'type' => 'string', + 'required' => false, + 'example' => 'Project', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + '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' => '请求ID', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回详情结果'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '管理平台用户id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'state' => [ + 'description' => '用户状态', + 'type' => 'string', + 'example' => 'normal', + ], + 'avatarUrl' => [ + 'description' => '头像URL。', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => 'web url', + 'type' => 'string', + 'example' => '""', + ], + 'email' => [ + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'memberName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'test_memeber_name', + ], + 'accessLevel' => [ + 'description' => '权限等级', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'expireAt' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2020-08-08 08:08:08', + ], + 'memberType' => [ + 'description' => '成员类型'."\n" + .'TEAMS - 部门'."\n" + .'USERS - 员工'."\n", + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '关联sourceID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + 'sourceType' => [ + 'description' => '关联sourceType'."\n" + .'可选值：Project / Namespace / Organization'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Project', + ], + 'name' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'codeup-test', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"state\\": \\"normal\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"memberName\\": \\"test_memeber_name\\",\\n \\"accessLevel\\": 40,\\n \\"expireAt\\": \\"2020-08-08 08:08:08\\",\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241,\\n \\"sourceType\\": \\"Project\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"codeup-test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateRepositoryMemberResponse>\\n <requestId>F590C9D8-E908-5B6C-95AC-56B7E8011FFA</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>success</errorCode>\\n <success>true</success>\\n <result>\\n <id>30815</id>\\n <state>normal</state>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100</avatarUrl>\\n <externUid>01133501525635538279</externUid>\\n <webUrl>\\"\\"</webUrl>\\n <email>[email protected]</email>\\n <memberName>test_memeber_name</memberName>\\n <accessLevel>40</accessLevel>\\n <expireAt>2020-08-08 08:08:08</expireAt>\\n <tbUserId>sweadsajojiwe</tbUserId>\\n <memberType>USERS</memberType>\\n <sourceId>223241</sourceId>\\n <sourceType>Project</sourceType>\\n <name>codeup</name>\\n <username>codeup-test</username>\\n </result>\\n</UpdateRepositoryMemberResponse>","errorExample":""}]', + 'title' => '更改代码库成员的权限', + 'description' => '代码库ID、用户ID为必填项，更新内容至少包含accessLevel和memberType。', + ], + 'UpdateGroupMember' => [ + 'summary' => '修改组成员，主要是成员的权限修改。', + 'path' => '/repository/groups/{groupId}/members/update/aliyun_pk', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '组成员的阿里云账号ID', + 'type' => 'string', + 'required' => true, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'accessLevel' => [ + 'description' => '成员权限'."\n" + .'- 20：浏览者'."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + 'memberType' => [ + 'description' => '填写默认值：USERS', + 'type' => 'string', + 'required' => false, + 'example' => 'USERS', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24661', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '状态 '."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20：浏览者 '."\n" + .'30：开发者'."\n" + .'40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'memberType' => [ + 'description' => '成员类型，默认为：USERS', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '关联的ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 24661,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n}","type":"json"}]', + 'title' => '修改组成员', + ], + 'ListRepositoryMemberWithInherited' => [ + 'summary' => '查询代码库成员列表，无分页。', + 'path' => '/repository/{repositoryId}/members/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '仓库Id', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2464454', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业Id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'AB270BBA-EFB1-5773-B3DC-07CD036F7352', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回参数', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20-浏览者'."\n" + .'30-开发者'."\n" + .'40-管理员'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'yunxiao', + ], + 'inherited' => [ + 'description' => '继承代码组信息', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '类型'."\n" + .'可选值：Group / OrgNamespace', + 'type' => 'string', + 'example' => 'Group', + ], + 'nameWithNamespace' => [ + 'description' => '代码组完整名称（含完整组名称）', + 'type' => 'string', + 'example' => 'test / test-group（斜杠两边有空格）', + ], + 'pathWithNamespace' => [ + 'description' => '代码组完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'test/test-group '."\n", + ], + 'visibilityLevel' => [ + 'description' => '可见性'."\n" + .'0-私有'."\n" + .'10-企业内公开', + 'type' => 'string', + 'example' => '0', + ], + 'path' => [ + 'description' => '代码组路径', + 'type' => 'string', + 'example' => 'test-group', + ], + 'name' => [ + 'description' => '代码组名称', + 'type' => 'string', + 'example' => 'test-group', + ], + 'id' => [ + 'description' => '代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"AB270BBA-EFB1-5773-B3DC-07CD036F7352\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"state\\": \\"active\\",\\n \\"accessLevel\\": 30,\\n \\"name\\": \\"codeup\\",\\n \\"id\\": 19285,\\n \\"username\\": \\"yunxiao\\",\\n \\"inherited\\": {\\n \\"type\\": \\"Group\\",\\n \\"nameWithNamespace\\": \\"test / test-group（斜杠两边有空格）\\",\\n \\"pathWithNamespace\\": \\"test/test-group \\\\n\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"path\\": \\"test-group\\",\\n \\"name\\": \\"test-group\\",\\n \\"id\\": 2022\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoryMemberWithInheritedResponse>\\n <errorMessage>error</errorMessage>\\n <requestId>56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB</requestId>\\n <errorCode>None</errorCode>\\n <success>true</success>\\n <result>\\n <externUserId>5f969843cd2214ba0e24327d</externUserId>\\n <email>[email protected]</email>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100</avatarUrl>\\n <state>active</state>\\n <accessLevel>40</accessLevel>\\n <name>codeup</name>\\n <id>19946</id>\\n <username>yunxiao</username>\\n <inherited>\\n <type>GROUP</type>\\n <nameWithNamespace>test/codeup</nameWithNamespace>\\n <pathWithNamespace>test / codeup\\n</pathWithNamespace>\\n <visibilityLevel>0</visibilityLevel>\\n <path>codeup</path>\\n <name>codeup</name>\\n <id>123</id>\\n </inherited>\\n </result>\\n</ListRepositoryMemberWithInheritedResponse>","errorExample":""}]', + 'title' => '查询代码库成员列表', + ], + 'GetProjectMember' => [ + 'summary' => '根据阿里云账号ID（aliyunPk）查询代码库成员信息。', + 'path' => '/repository/{repositoryId}/members/get/{aliyunPk}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5eb53bb338076f00011bcfd5', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken（选填），使用AK方式调用时无需填accessToken', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码仓库Id', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1869702', + ], + ], + [ + 'name' => 'aliyunPk', + 'in' => 'path', + 'schema' => [ + 'title' => '用户阿里云PK', + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1232456789123467', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'description' => '请求ID', + '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' => '权限类型'."\n" + .'20-浏览者'."\n" + .'30-开发者'."\n" + .'40-管理员'."\n" + ."\n", + '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' => 'Codeup用户ID，无业务实际意义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2959', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"30C99C69-A340-5E2E-ACE4-8888FF50CF52\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"accessLevel\\": 30,\\n \\"name\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"id\\": 2959,\\n \\"email\\": \\"[email protected]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProjectMemberResponse>\\n <errorMessage>”“</errorMessage>\\n <requestId>30C99C69-A340-5E2E-ACE4-8888FF50CF52</requestId>\\n <errorCode>NOT_FOUND</errorCode>\\n <success>true</success>\\n <result>\\n <accessLevel>40</accessLevel>\\n <externUserId>5f969843cd2214ba0e24327d</externUserId>\\n <name>codeup</name>\\n <avatarUrl>https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100</avatarUrl>\\n <id>2959</id>\\n </result>\\n</GetProjectMemberResponse>","errorExample":""}]', + 'title' => '查询代码库成员', + 'description' => '确保aliyunPk在之前已经登录过云效相关产品。', + ], + 'ListGroupMember' => [ + 'summary' => '查询代码组下的成员列表，无分页，无排序。', + 'path' => '/repository/groups/{groupId}/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '632bbfdf419338aaa2b1360a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'test-codeup-nickname', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'- 20-浏览者'."\n" + .'- 30-开发者'."\n" + .'- 40-管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'memberType' => [ + 'description' => '成员类型，默认为USERS'."\n" + .'TEAMS - 部门'."\n" + .'USERS - 员工', + 'type' => 'string', + 'example' => 'USERS', + ], + 'sourceId' => [ + 'description' => '关联的sourceId，该API一般指代码组的ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223241', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C8F8B434-B006-59FB-8B9C-0382CF3D5680\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 123456,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"accessLevel\\": 30,\\n \\"memberType\\": \\"USERS\\",\\n \\"sourceId\\": 223241\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询组成员列表', + ], + 'CreateRepository' => [ + 'summary' => '创建或者导入代码库。', + 'path' => '/repository/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'sync', + 'in' => 'query', + 'schema' => [ + 'description' => '是否同步执行创建仓库'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'createParentPath', + 'in' => 'query', + 'schema' => [ + 'description' => '是否创建父目录'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '代码库名称', + 'description' => '代码库名称', + 'type' => 'string', + 'required' => true, + 'example' => 'Demo库', + ], + 'path' => [ + 'title' => '代码库路径', + 'description' => '代码库路径', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo库（与name保持同层级，name与path的值可以不同，若带上了父路径，那么需要设置createParentPath字段为true，且父路径前面不加斜杠，如 parentPath/demo）', + ], + 'namespaceId' => [ + 'title' => '代码库父路径id', + 'description' => '代码库父路径id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2022（需要保证当前用户在父路径下有创建代码库的权限；若需要创建父路径，那么namespaceId需要设置为企业的空间ID）', + ], + 'description' => [ + 'title' => '代码库描述', + 'description' => '代码库描述', + 'type' => 'string', + 'required' => false, + 'example' => '测试内容', + ], + 'visibilityLevel' => [ + 'description' => '代码仓库可见性'."\n" + .'0 - 私有，仅代码库成员可见'."\n" + .'10 - 企业内公开，企业成员可见', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + ], + 'importUrl' => [ + 'title' => '导入地址（http协议地址）', + 'description' => '待导入代码库地址（http协议），例如github平台上的代码库地址', + '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' => '导入时账号的token', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + 'importTokenEncrypted' => [ + 'title' => 'import_token字段的传输格式，使用明文或rsa加密', + 'description' => 'importToken字段的传输格式，使用明文或rsa加密'."\n" + .'可选值：text（明文） / rsa（rsa加密）', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'importDemoProject' => [ + 'title' => '使用使用demo库内容进行初始化', + 'description' => '是否导入示例项目'."\n" + .'可选值：true / false', + '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' => '自动创建readme类型 '."\n" + .'EMPTY - 仅创建README.md'."\n" + .'USER_GUIDE - 包含新手引导', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'USER_GUIDE' => '创建包含新手引导内容的README.md文件', + 'EMPTY' => '仅创建空的README.md文件', + ], + 'example' => 'USER_GUIDE', + ], + 'importRepoType' => [ + 'title' => '导入代码库类型 (GIT: Git库, SVN: SVN库)', + 'description' => '导入代码库类型'."\n" + .'GIT - Git库'."\n" + .'SVN - SVN库', + 'type' => 'string', + 'required' => false, + 'example' => 'GIT', + ], + 'initStandardService' => [ + 'title' => '初始化标准智能化服务', + 'description' => '初始化标准智能化服务'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'gitignoreType' => [ + 'title' => 'gitignore模板类型', + 'description' => 'gitignore模板类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + 'isCryptoEnabled' => [ + 'title' => '是否启用加密', + 'description' => '是否启用加密'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'localImportUrl' => [ + 'title' => '本地导入代码库的远程地址', + 'description' => '本地导入代码库的远程地址', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'SYSTEM_UNAUTHORIZED_ERROR', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '401', + ], + 'success' => [ + 'title' => '调用是否成功', + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回详情结果'."\n" + ."\n", + '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' => '可见性。0：私有，10：内部公开', + 'type' => 'string', + 'example' => '0', + ], + 'sshUrlToRepo' => [ + 'title' => 'ssh地址', + 'description' => 'ssh地址', + 'type' => 'string', + 'example' => '""', + ], + 'httpUrlToRepo' => [ + 'title' => 'http地址', + 'description' => 'http地址', + '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' => '创建者id', + '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' => '归属者id', + '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' => '可见性。0：私有，10：内部公开', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'archived' => [ + 'title' => '归档标识', + 'description' => '归档标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatar_url' => [ + 'title' => '代码库头像地址', + 'description' => '代码库头像地址', + 'type' => 'string', + 'example' => '""', + ], + 'demoProject' => [ + 'title' => 'demo库标识', + 'description' => 'demo库标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Import_from_svn' => [ + 'title' => '从SVN导入', + 'description' => '从SVN导入', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"SYSTEM_UNAUTHORIZED_ERROR\\",\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorCode\\": \\"401\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2959,\\n \\"description\\": \\"线下测试\\",\\n \\"defaultBranch\\": \\"master\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"sshUrlToRepo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"httpUrlToRepo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"name\\": \\"codeupTest\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"creatorId\\": 1233,\\n \\"namespace\\": {\\n \\"id\\": 3194,\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"codeup\\",\\n \\"ownerId\\": 123,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"description\\": \\"codeup repo description\\",\\n \\"avatar\\": \\"\\\\\\"\\\\\\"\\",\\n \\"public\\": true,\\n \\"visibilityLevel\\": \\"0\\"\\n },\\n \\"archived\\": false,\\n \\"avatar_url\\": \\"\\\\\\"\\\\\\"\\",\\n \\"demoProject\\": false,\\n \\"Import_from_svn\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRepositoryResponse>\\n <errorMessage>SYSTEM_UNAUTHORIZED_ERROR</errorMessage>\\n <requestId>F590C9D8-E908-5B6C-95AC-56B7E8011FFA</requestId>\\n <errorCode>401</errorCode>\\n <success>true</success>\\n <result>\\n <id>2959</id>\\n <description>线下测试</description>\\n <defaultBranch>master</defaultBranch>\\n <visibilityLevel>0</visibilityLevel>\\n <sshUrlToRepo>\\"\\"</sshUrlToRepo>\\n <httpUrlToRepo>\\"\\"</httpUrlToRepo>\\n <webUrl>\\"\\"</webUrl>\\n <name>codeupTest</name>\\n <nameWithNamespace>codeup-test-org / test-codeup</nameWithNamespace>\\n <path>test-codeup</path>\\n <pathWithNamespace>codeup-test-org/test-codeup</pathWithNamespace>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <lastActivityAt>2022-01-14T21:08:26+08:00</lastActivityAt>\\n <creatorId>1233</creatorId>\\n <namespace>\\n <id>3194</id>\\n <name>codeup</name>\\n <path>codeup</path>\\n <ownerId>123</ownerId>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <updatedAt>2022-01-14T21:08:26+08:00</updatedAt>\\n <description>codeup repo description</description>\\n <avatar>\\"\\"</avatar>\\n <public>true</public>\\n <visibilityLevel>0</visibilityLevel>\\n </namespace>\\n <archived>false</archived>\\n <avatar_url>\\"\\"</avatar_url>\\n <demoProject>false</demoProject>\\n <Import_from_svn>false</Import_from_svn>\\n </result>\\n</CreateRepositoryResponse>","errorExample":""}]', + 'title' => '创建/导入代码库', + ], + 'DeleteRepository' => [ + 'summary' => '删除代码库。（为了保证规范性，必须填写删除理由）。', + 'path' => '/repository/{repositoryId}/remove', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6082a9b0c7972588ac363793', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'description' => '删除代码库原因（必填）', + 'type' => 'string', + 'required' => true, + 'example' => '代码库废弃且不再使用', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '删除代码库', + ], + 'UpdateRepository' => [ + 'summary' => '更新代码库基本信息、常用设置。', + 'path' => '/repository/{repositoryId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c3c09f1230187a879678da43c973d069', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080398', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2080398', + ], + 'name' => [ + 'description' => '代码库名称', + 'type' => 'string', + 'required' => false, + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '代码库路径', + 'type' => 'string', + 'required' => false, + 'example' => 'codeup-demo', + ], + 'description' => [ + 'description' => '代码库描述', + 'type' => 'string', + 'required' => false, + 'example' => 'codeup描述信息', + ], + 'defaultBranch' => [ + 'description' => '默认分支', + 'type' => 'string', + 'required' => false, + 'example' => 'master', + ], + 'issuesEnabled' => [ + 'description' => '是否开启issues'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '是否开启代码合并'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'buildsEnabled' => [ + 'description' => '是否开启构建'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'wikiEnabled' => [ + 'description' => '是否开启wiki'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'snippetsEnabled' => [ + 'description' => '是否开启snippets', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'visibilityLevel' => [ + 'description' => '代码仓库可见性'."\n" + .'0：私有，仅代码库成员可见'."\n" + .'10：企业内公开，企业成员可见'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'checkEmail' => [ + 'description' => '是否检查邮箱'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'avatar' => [ + 'description' => '头像地址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx', + ], + 'openCloneDownloadControl' => [ + 'description' => '是否开启克隆下载控制'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'projectCloneDownloadRoleList' => [ + 'description' => '被允许的拉取代码角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '角色', + 'type' => 'object', + 'properties' => [ + 'roleCode' => [ + 'description' => '角色代码'."\n" + .'15：空间成员'."\n" + .'60：空间管理员'."\n" + .'70：空间拥有者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + 'allowed' => [ + 'description' => '是否允许'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'projectCloneDownloadMethodList' => [ + 'description' => '被允许的拉取代码方法列表', + 'type' => 'array', + 'items' => [ + 'description' => '允许拉取代码的方法', + 'type' => 'object', + 'properties' => [ + 'permissionCode' => [ + 'description' => 'clone下载权限码'."\n" + .'`project:ssh-clone` ：允许ssh clone'."\n" + .'`project:http-clone`：允许http clone'."\n" + .'`project:download`：允许下载'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'project:download', + ], + 'allowed' => [ + 'description' => '是否允许'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'adminSettingLanguage' => [ + 'description' => '仓库主要编程语言（需管理员权限）', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '“”', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR'."\n", + ], + 'success' => [ + 'description' => ' '."\n" + .'调用是否成功'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2825387', + ], + 'name' => [ + 'description' => '代码库名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'nameWithNamespace' => [ + 'description' => '代码库完整名称（含完整组名称）', + 'type' => 'string', + 'example' => 'codeup-test-org / codeup（斜杠两侧有空格）', + ], + 'path' => [ + 'description' => '代码库路径', + 'type' => 'string', + 'example' => 'codeup', + ], + 'pathWithNamespace' => [ + 'description' => '代码库完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'codeup-test-org / codeup', + ], + 'description' => [ + 'description' => '代码库描述', + 'type' => 'string', + 'example' => 'codeup代码库描述', + ], + 'defaultBranch' => [ + 'description' => '默认分支', + 'type' => 'string', + 'example' => 'master', + ], + 'visibilityLevel' => [ + 'description' => '可见性'."\n" + .'0：私有，仅代码库成员可见'."\n" + .'10：企业内公开，企业成员可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'sshUrlToRepo' => [ + 'description' => '代码库的SSH克隆地址', + 'type' => 'string', + 'example' => '[email protected]:xxx/test/test.git'."\n", + ], + 'httpUrlToRepo' => [ + 'description' => '代码库的HTTP克隆地址', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test.git'."\n", + ], + 'webUrl' => [ + 'description' => '代码库的页面访问地址'."\n", + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", + ], + 'issuesEnabled' => [ + 'description' => '是否开启issues'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '是否开启合并请求'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'buildsEnabled' => [ + 'description' => '是否开启构建'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'wikiEnabled' => [ + 'description' => '是否开启wiki'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'snippetsEnabled' => [ + 'description' => '是否开启snippets'."\n" + .'可选值：true / false', + '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' => '创建者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'namespace' => [ + 'description' => '代码库所属组或企业空间信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '组或企业空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29322', + ], + 'name' => [ + 'description' => '组或企业空间名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '组或企业路径（判断父路径是组还是企业）', + 'type' => 'string', + 'example' => '地址：https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/blank923/repo-test'."\n" + .'组路径：blank923'."\n" + .'企业路径：60d54f3daccf2bbd6659f3ad', + ], + 'ownerId' => [ + 'description' => '组或企业空间的拥有者ID', + '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' => '代码仓库可见性'."\n" + .'0：私有'."\n" + .'10：企业内公开，企业成员可见'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'archived' => [ + 'description' => '归档标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatarUrl' => [ + 'description' => '代码库的头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EAE03103-5497-58D1-9169-E524DDE8604C\\",\\n \\"errorMessage\\": \\"“”\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2825387,\\n \\"name\\": \\"codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / codeup（斜杠两侧有空格）\\",\\n \\"path\\": \\"codeup\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org / codeup\\",\\n \\"description\\": \\"codeup代码库描述\\",\\n \\"defaultBranch\\": \\"master\\",\\n \\"visibilityLevel\\": 0,\\n \\"sshUrlToRepo\\": \\"[email protected]:xxx/test/test.git\\\\n\\",\\n \\"httpUrlToRepo\\": \\"https://codeup.aliyun.com/xxx/test/test.git\\\\n\\",\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\\\n\\",\\n \\"issuesEnabled\\": true,\\n \\"mergeRequestsEnabled\\": true,\\n \\"buildsEnabled\\": false,\\n \\"wikiEnabled\\": true,\\n \\"snippetsEnabled\\": false,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"lastActivityAt\\": \\"2022-03-20 14:24:54\\",\\n \\"creatorId\\": 19238,\\n \\"namespace\\": {\\n \\"id\\": 29322,\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"地址：https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/blank923/repo-test\\\\n组路径：blank923\\\\n企业路径：60d54f3daccf2bbd6659f3ad\\",\\n \\"ownerId\\": 19238,\\n \\"createdAt\\": \\"2022-02-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"description\\": \\"组或企业空间的描述信息\\",\\n \\"avatar\\": \\"https://xxx\\",\\n \\"visibilityLevel\\": 0\\n },\\n \\"archived\\": false,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n}","type":"json"}]', + 'title' => '更新代码库', + ], + 'TriggerRepositoryMirrorSync' => [ + 'summary' => '从其他平台导入到Codeup的仓库，触发Codeup仓库从远程同步。', + 'path' => '/repository/{repositoryId}/mirror', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => '个人访问令牌。 使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码库ID', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '100', + ], + ], + [ + 'name' => 'account', + 'in' => 'query', + 'schema' => [ + 'title' => '远程同步库克隆账号', + 'description' => '远程同步库克隆账号', + 'type' => 'string', + 'required' => false, + 'example' => 'test-account', + ], + ], + [ + 'name' => 'token', + 'in' => 'query', + 'schema' => [ + 'title' => '远程同步库克隆令牌', + 'description' => '远程同步库克隆令牌', + 'type' => 'string', + 'required' => false, + 'example' => 'asd12e44827fe2444f952e931e51xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '企业不存在', + ], + 'requestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A', + ], + 'success' => [ + 'title' => '请求结果', + 'description' => '请求结果', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_ILLEGAL_ARGUMENT_ERROR', + ], + 'result' => [ + 'title' => '响应结果', + 'description' => '响应结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'title' => '仓库同步触发结果', + 'description' => '仓库同步触发结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + [ + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"企业不存在\\",\\n \\"requestId\\": \\"37294673-00CA-5B8B-914F-A8B35511E90A\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_ILLEGAL_ARGUMENT_ERROR\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<TriggerRepositoryMirrorSyncResponse>\\n <errorMessage>xxx</errorMessage>\\n <requestId>xxxx-xxxx-xxx-xxxxx</requestId>\\n <success>true</success>\\n <errorCode>SYSTEM_ILLEGAL_ARGUMENT_ERROR</errorCode>\\n <result>\\n <result>true</result>\\n </result>\\n</TriggerRepositoryMirrorSyncResponse>","errorExample":""}]', + 'title' => '触发仓库同步', + ], + 'TransferRepository' => [ + 'summary' => '转移代码库至指定的代码组，其中groupId和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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2080972 或 orgId/test-group-1/test-repo', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '代码组ID或全路径', + 'type' => 'string', + 'required' => true, + 'example' => '34839 或 orgId/transfer-group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码库ID', + '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' => '描述信息的具体内容'."\n", + ], + 'pathWithNamespace' => [ + 'description' => '代码库完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'codeup-test-org/test-create-codeup', + ], + 'nameWithNamespace' => [ + 'description' => '代码库完整名称（含完整组名称）', + 'type' => 'string', + 'example' => 'codeup-test-org / test-create-group （斜杠两侧有空格）', + ], + 'visibilityLevel' => [ + 'description' => '可见性'."\n" + .'- 0：私有，仅代码库成员可见'."\n" + .'- 10：企业内公开，企业成员可见'."\n" + .'- 20：表示全平台公开', + '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' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'starred' => [ + 'description' => '是否被当前用户收藏', + 'type' => 'boolean', + 'example' => 'true', + ], + 'namespaceId' => [ + 'description' => '上级路径的ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'- 20-浏览者'."\n" + .'- 30-开发者'."\n" + .'- 40-管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'demoProject' => [ + 'description' => 'demo库标识', + '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' => '创建者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'encrypted' => [ + 'description' => '加密标识', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 19285,\\n \\"path\\": \\"test-repo\\",\\n \\"name\\": \\"test-repo\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-create-codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"visibilityLevel\\": 0,\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"starCount\\": 0,\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"starred\\": true,\\n \\"namespaceId\\": 100003,\\n \\"accessLevel\\": 30,\\n \\"demoProject\\": false,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"archived\\": false,\\n \\"creatorId\\": 19238,\\n \\"encrypted\\": false\\n }\\n}","type":"json"}]', + 'title' => '转移代码库', + ], + '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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码'."\n" + .'默认值为1，从第1页开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段'."\n" + .'可选值：created_at,id,name,path,updated_at,last_activity_at”', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式 (desc: 降序, asc: 升序)', + 'description' => '排序方式 '."\n" + .'默认值为desc'."\n" + .'desc - 降序'."\n" + .'asc - 升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键字', + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'archived', + 'in' => 'query', + 'schema' => [ + 'title' => '是否列出归档项目', + 'description' => '是否列出归档项目'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '最小权限过滤，枚举值：'."\n" + .'- 20：浏览者'."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求requestId', + 'description' => '请求ID', + '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' => 'SYSTEM_UNKNOWN_ERROR', + ], + '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' => '上级路径的id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '745', + ], + 'avatarUrl' => [ + 'title' => '头像地址', + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + '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' => '代码库导入状态'."\n" + .'可选值：started / finished / failed / stopping / none', + 'type' => 'string', + 'example' => 'started', + ], + 'webUrl' => [ + 'title' => '页面访问时的URL', + 'description' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'description' => [ + 'title' => '代码库描述', + 'description' => '代码库描述', + 'type' => 'string', + 'example' => '测试Codeup托管', + ], + 'nameWithNamespace' => [ + 'title' => '代码库完整名称（含完整组名称）', + 'description' => '代码库完整名称（含完整组名称）', + 'type' => 'string', + 'example' => 'codeup-test-org / test-codeup（斜杠两侧有空格）', + ], + 'pathWithNamespace' => [ + 'title' => '代码库完整路径（含完整组路径）', + 'description' => '代码库完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'codeup-test-org/test-codeup', + ], + 'path' => [ + 'title' => '代码库路径', + 'description' => '代码库路径', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'visibilityLevel' => [ + 'title' => '可见性;0标识私有的/10标识企业内公开', + 'description' => '可见性'."\n" + .'0 - 私有，仅代码库成员可见'."\n" + .'10 - 企业内公开，企业成员可见', + 'type' => 'string', + 'example' => '0', + ], + 'accessLevel' => [ + 'title' => '当前用户在该代码库上的权限类型', + 'description' => '权限类型'."\n" + .'20-浏览者'."\n" + .'30-开发者'."\n" + .'40-管理员', + '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' => '代码库Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 149,\\n \\"success\\": true,\\n \\"errorCode\\": 0,\\n \\"result\\": [\\n {\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"namespaceId\\": 745,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"starCount\\": 0,\\n \\"archive\\": false,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"star\\": false,\\n \\"importStatus\\": \\"started\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"测试Codeup托管\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-codeup（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"visibilityLevel\\": \\"0\\",\\n \\"accessLevel\\": 40,\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"name\\": \\"codeupTest\\",\\n \\"Id\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoriesResponse>\\n <requestId>4D6AF7CC-B43B-5454-86AB-023D25E44868</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <total>149</total>\\n <success>true</success>\\n <result>\\n <lastActivityAt>2022-01-14T21:08:26+08:00</lastActivityAt>\\n <namespaceId>745</namespaceId>\\n <avatarUrl>\\"\\"</avatarUrl>\\n <starCount>0</starCount>\\n <archive>false</archive>\\n <createdAt>2022-01-14T21:08:26+08:00</createdAt>\\n <star>false</star>\\n <importStatus>\\"\\"</importStatus>\\n <webUrl>\\"\\"</webUrl>\\n <description>测试Codeup托管</description>\\n <nameWithNamespace>codeup-test-org / test-codeup</nameWithNamespace>\\n <pathWithNamespace>codeup-test-org/test-codeup</pathWithNamespace>\\n <path>test-codeup</path>\\n <visibilityLevel>0</visibilityLevel>\\n <accessLevel>40</accessLevel>\\n <updatedAt>2022-01-14T21:08:26+08:00</updatedAt>\\n <name>codeupTest</name>\\n <Id>1</Id>\\n </result>\\n</ListRepositoriesResponse>","errorExample":""}]', + 'title' => '查询代码库列表', + ], + 'GetRepository' => [ + 'summary' => '查询代码库，支持按代码库ID和代码库路径(Path)查询。', + 'path' => '/repository/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业ID', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => '个人访问令牌', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'identity', + 'in' => 'query', + 'schema' => [ + 'title' => '代码库ID或路径', + 'description' => '代码库ID或路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => '响应结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '37294673-00CA-5B8B-914F-A8B35511E90A', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '请求是否成功', + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'repository' => [ + 'title' => '代码库信息', + 'description' => '代码库信息', + 'type' => 'object', + 'properties' => [ + 'archive' => [ + 'title' => '归档标识', + 'description' => '归档标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'avatarUrl' => [ + 'title' => '代码库头像地址', + 'description' => '代码库头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-06-19T04:02:00.744Z', + ], + 'creatorId' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19258', + ], + 'defaultBranch' => [ + 'title' => '默认分支', + 'description' => '默认分支', + 'type' => 'string', + 'example' => 'master', + ], + 'demoProjectStatus' => [ + 'title' => 'DEMO库标识', + 'description' => 'DEMO库标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'repo desc', + ], + 'httpUrlToRepository' => [ + 'title' => 'HTTP克隆地址', + 'description' => 'HTTP克隆地址', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test.git', + ], + 'id' => [ + 'title' => '代码库ID', + 'description' => '代码库ID', + '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' => '归属者ID'."\n" + ."\n" + .'> 即，用户主键ID', + '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' => '可见性'."\n" + .'0 - 私有，仅代码库成员可见'."\n" + .'10 - 企业内公开，企业成员可见', + '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' => 'SSH克隆地址', + 'type' => 'string', + 'example' => '[email protected]:xxx/test/test.git', + ], + 'visibilityLevel' => [ + 'title' => '可见性。0：私有，10：内部公开', + 'description' => '可见性'."\n" + .'0 - 私有，仅代码库成员可见'."\n" + .'10 - 企业内部公开，企业成员可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'webUrl' => [ + 'title' => '页面访问地址', + 'description' => '页面访问地址', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"37294673-00CA-5B8B-914F-A8B35511E90A\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"repository\\": {\\n \\"archive\\": false,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"createdAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"creatorId\\": 19258,\\n \\"defaultBranch\\": \\"master\\",\\n \\"demoProjectStatus\\": false,\\n \\"description\\": \\"repo desc\\",\\n \\"httpUrlToRepository\\": \\"https://codeup.aliyun.com/xxx/test/test.git\\",\\n \\"id\\": 100,\\n \\"lastActivityAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"name\\": \\"test\\",\\n \\"nameWithNamespace\\": \\"test / test（斜杠两侧有空格）\\",\\n \\"namespace\\": {\\n \\"id\\": 100,\\n \\"avatar\\": \\"https://xxx.jpg\\",\\n \\"createdAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"description\\": \\"repo desc\\",\\n \\"name\\": \\"xxx\\",\\n \\"ownerId\\": 100,\\n \\"path\\": \\"test\\",\\n \\"updatedAt\\": \\"2020-06-19T04:02:00.744Z\\",\\n \\"visibilityLevel\\": 0\\n },\\n \\"path\\": \\"test\\",\\n \\"pathWithNamespace\\": \\"test/test\\",\\n \\"sshUrlToRepository\\": \\"[email protected]:xxx/test/test.git\\",\\n \\"visibilityLevel\\": 0,\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRepositoryResponse>\\n <requestId>37294673-00CA-5B8B-914F-A8B35511E90A</requestId>\\n <errorCode>null</errorCode>\\n <errorMessage>null</errorMessage>\\n <success>false</success>\\n <repository>\\n <archive>false</archive>\\n <avatarUrl>https://xxx.jpg</avatarUrl>\\n <createdAt>2020-06-19T04:02:00.744Z</createdAt>\\n <creatorId>100</creatorId>\\n <defaultBranch>master</defaultBranch>\\n <demoProjectStatus>false</demoProjectStatus>\\n <description>repo desc</description>\\n <httpUrlToRepository>https://codeup.aliyun.com/xxx/test/test.git</httpUrlToRepository>\\n <id>100</id>\\n <lastActivityAt>2020-06-19T04:02:00.744Z</lastActivityAt>\\n <name>test</name>\\n <nameWithNamespace>test / test</nameWithNamespace>\\n <namespace>\\n <id>100</id>\\n <avatar>https://xxx.jpg</avatar>\\n <createdAt>2020-06-19T04:02:00.744Z</createdAt>\\n <description>repo desc</description>\\n <name>xxx</name>\\n <ownerId>100</ownerId>\\n <path>test</path>\\n <updatedAt>2020-06-19T04:02:00.744Z</updatedAt>\\n <visibilityLevel>0</visibilityLevel>\\n </namespace>\\n <path>test</path>\\n <pathWithNamespace>test/test</pathWithNamespace>\\n <sshUrlToRepository>[email protected]:xxx/test/test.git</sshUrlToRepository>\\n <visibilityLevel>0</visibilityLevel>\\n <webUrl>https://codeup.aliyun.com/xxx/test/test</webUrl>\\n </repository>\\n</GetRepositoryResponse>","errorExample":""}]', + 'title' => '查询代码库', + ], + 'CreateBranch' => [ + 'summary' => '创建代码库分支。', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'string', + 'required' => true, + 'example' => '2334815', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'createBranch', + ], + 'ref' => [ + 'description' => '来源分支，指从某个分支创建新分支。', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'createBranch', + ], + 'protected' => [ + 'description' => '是否是保护分支', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commit' => [ + 'description' => '分支最近一次提交信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'ff4fb5ac6d1f44f452654336d2dba468ae6c8d04', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'ff4fb5ac', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '创建代码库分支', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => 'create branch', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '阿里云云效committer', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"name\\": \\"createBranch\\",\\n \\"protected\\": false,\\n \\"commit\\": {\\n \\"id\\": \\"ff4fb5ac6d1f44f452654336d2dba468ae6c8d04\\",\\n \\"shortId\\": \\"ff4fb5ac\\",\\n \\"title\\": \\"创建代码库分支\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"create branch\\",\\n \\"authoredDate\\": \\"2022-03-18 09:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建分支', + ], + 'CreateProtectdBranch' => [ + 'summary' => '创建代码库保护分支。', + 'path' => '/repository/{repositoryId}/protect_branches', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813891', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '--', + ], + 'branch' => [ + 'description' => '保护分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'protectBranch', + ], + 'allowPushRoles' => [ + 'description' => '允许推送角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowPushUserIds' => [ + 'description' => '允许推送用户ID', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '2344667212345561', + ], + 'required' => false, + ], + 'allowMergeRoles' => [ + 'description' => '允许合并角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '[40, 30]', + ], + 'required' => true, + ], + 'allowMergeUserIds' => [ + 'description' => '允许合并用户ID', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '123345678912345', + ], + 'required' => false, + ], + 'mergeRequestSetting' => [ + 'description' => '合并前的代码评审设置', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '是否开启', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '评审模式'."\n" + .'- general：普通'."\n" + .'- codeowner：CodeOwner模式', + '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' => '评审通过的最少人数'."\n" + .'> 仅普通模式生效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '允许合并角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员（默认） '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'defaultAssignees' => [ + 'description' => '默认评审人', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '1234567891234567', + ], + 'required' => false, + ], + 'whiteList' => [ + 'description' => '评审文件白名单'."\n" + .'><notice>加入白名单的文件不受「评审通过的最少人数」限制，无需强制人工评审></notice>', + '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' => 'MR卡点流水线配置', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '配置项', + 'type' => 'array', + 'items' => [ + 'description' => '配置项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => false, + 'example' => '测试流水线', + ], + 'isRequired' => [ + 'description' => '是否卡点', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'branch' => [ + 'description' => '保护分支名称', + 'type' => 'string', + 'example' => 'protectBranch', + ], + 'allowPushRoles' => [ + 'description' => '允许推送角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理者 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'allowPushUserIds' => [ + 'description' => '允许推送用户ID列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowMergeRoles' => [ + 'description' => '允许合并角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理者 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '允许合并用户ID', + 'type' => 'array', + 'items' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'mergeRequestSetting' => [ + 'description' => '合并前的代码评审设置', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '是否开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '评审模式'."\n" + ."\n" + .'- general：普通'."\n" + .'- codeowner：CodeOwner模式', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '是否允许创建者通过代码评审', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '是否要求评审全部已解决', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '是否在有新的提交时重置评审', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '评审通过的最少人数'."\n" + .'注：仅普通模式生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '允许合并请求角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员（默认） '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + 'defaultAssignees' => [ + 'description' => '默认评审人ID', + 'type' => 'array', + 'items' => [ + 'description' => '云效用户ID', + 'type' => 'string', + 'example' => '5f969843cd2214ba0e24327d', + ], + ], + 'whiteList' => [ + 'description' => '评审文件白名单'."\n" + .'注意：加入白名单的文件不受「评审通过的最少人数」限制，无需强制人工评审', + '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' => 'MR卡点流水线配置', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '配置项列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'example' => '测试流水线', + ], + 'isRequired' => [ + 'description' => '是否卡点', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 5240,\\n \\"branch\\": \\"protectBranch\\",\\n \\"allowPushRoles\\": [\\n 40\\n ],\\n \\"allowPushUserIds\\": [\\n 19238\\n ],\\n \\"allowMergeRoles\\": [\\n 40\\n ],\\n \\"allowMergeUserIds\\": [\\n 19238\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 40\\n ],\\n \\"defaultAssignees\\": [\\n \\"5f969843cd2214ba0e24327d\\"\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建保护分支', + ], + 'DeleteBranch' => [ + 'summary' => '删除代码库分支。', + 'path' => '/repository/{repositoryId}/branches/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '619b80042f595dbd1b9b0de2', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2185366', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'deleteBranch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'branchName' => [ + 'description' => '删除的分支名称', + 'type' => 'string', + 'example' => 'deleteBranch', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"branchName\\": \\"deleteBranch\\"\\n }\\n}","type":"json"}]', + 'title' => '删除分支', + ], + '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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '611b75680fc7bf0dbe1dce55', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'protectedBranchId', + 'in' => 'path', + 'schema' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5326', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1F4F342D-493A-5B2C-B133-BA78B30FF834', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1F4F342D-493A-5B2C-B133-BA78B30FF834\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '删除保护分支', + ], + 'UpdateProtectedBranches' => [ + 'summary' => '更改保护分支设置。 支持对于保护分支规则的详细设置，包括分支、推送规则、合并规则、要求合并前通过代码评审以及要求合并前通过自动化状态检查。', + 'path' => '/{repositoryId}/protect_branches/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken（选填），使用AK方式调用时无需填accessToken', + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2835387', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '19224', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '19224', + ], + 'branch' => [ + 'description' => '代码分支名称（若不修改保护分支，则维持原来的分支名；若需要修改保护分支，则给予修改的分支名称）', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + 'allowPushRoles' => [ + 'description' => '允许推送的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowPushUserIds' => [ + 'description' => '允许推送的用户ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '[19258, 19262]', + ], + 'required' => false, + ], + 'allowMergeRoles' => [ + 'description' => '允许合并的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'allowMergeUserIds' => [ + 'description' => '允许合并的用户ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '[19258, 19262]', + ], + 'required' => false, + ], + 'mergeRequestSetting' => [ + 'description' => '合并前的代码评审设置', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '是否开启', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '评审模式 '."\n" + .'general - 普通 '."\n" + .'codeowner - CodeOwner模式', + 'type' => 'string', + 'required' => false, + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '是否允许创建者通过代码评审'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '是否要求评论全部已解决'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '是否在有新的提交时重置评审'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '评审通过的最少人数'."\n" + .'注：仅普通模式生效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '允许通过合并请求的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员（默认） '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[40, 30]', + ], + 'required' => false, + ], + 'defaultAssignees' => [ + 'description' => '默认评审者的ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + 'whiteList' => [ + 'description' => '评审文件白名单'."\n" + .'注意：加入白名单的文件不受「评审通过的最少人数」限制，无需强制人工评审', + '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' => 'MR卡点流水线配置', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '配置项列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => false, + 'example' => '测试流水线', + ], + 'isRequired' => [ + 'description' => '是否卡点', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR'."\n", + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回详情结果'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '保护分支规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'branch' => [ + 'description' => '代码分支名称', + 'type' => 'string', + 'example' => 'master', + ], + 'allowPushRoles' => [ + 'description' => '允许推送的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理者 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowPushUserIds' => [ + 'description' => '允许推送的用户ID', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[19258, 19262]', + ], + ], + 'allowMergeRoles' => [ + 'description' => '允许合并的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理者 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '允许合并的用户ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[19258, 19262]', + ], + ], + 'mergeRequestSetting' => [ + 'description' => '合并前的代码评审设置', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '是否开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '评审模式 '."\n" + .'general：普通 '."\n" + .'codeowner：CodeOwner模式', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '是否允许创建者通过代码评审', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '是否要求评审全部已解决', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '是否在有新的提交时重置评审', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '评审通过的最少人数'."\n" + .'注：仅普通模式生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '允许通过合并请求的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员（默认） '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'defaultAssignees' => [ + 'description' => '默认评审者的ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '1234', + ], + ], + 'whiteList' => [ + 'description' => '评审文件白名单'."\n" + .'注意：加入白名单的文件不受「评审通过的最少人数」限制，无需强制人工评审', + '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' => 'MR卡点流水线配置', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '配置项列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'example' => '测试流水线', + ], + 'isRequired' => [ + 'description' => '是否卡点', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A35869D5-BB29-5F84-A4DD-B09985EA2AFA\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\t\\\\nSYSTEM_UNKNOWN_ERROR\\\\n\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 123456,\\n \\"branch\\": \\"master\\",\\n \\"allowPushRoles\\": [\\n 0\\n ],\\n \\"allowPushUserIds\\": [\\n 0\\n ],\\n \\"allowMergeRoles\\": [\\n 0\\n ],\\n \\"allowMergeUserIds\\": [\\n 0\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 0\\n ],\\n \\"defaultAssignees\\": [\\n \\"1234\\"\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateProtectedBranchesResponse>\\n <requestId>A35869D5-BB29-5F84-A4DD-B09985EA2AFA</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>success</errorCode>\\n <success>false</success>\\n <result>\\n <id>123456</id>\\n <branch>master</branch>\\n <allowPushRoles>40</allowPushRoles>\\n <allowPushRoles>30</allowPushRoles>\\n <allowPushUserIds>123456</allowPushUserIds>\\n <allowMergeRoles>40</allowMergeRoles>\\n <allowMergeRoles>30</allowMergeRoles>\\n <allowMergeUserIds>123456</allowMergeUserIds>\\n <mergeRequestSetting>\\n <isRequired>true</isRequired>\\n <mrMode>general</mrMode>\\n <isAllowSelfApproval>true</isAllowSelfApproval>\\n <isRequireDiscussionProcessed>true</isRequireDiscussionProcessed>\\n <isResetApprovalWhenNewPush>false</isResetApprovalWhenNewPush>\\n <minimumApproval>1</minimumApproval>\\n <allowMergeRequestRoles>40</allowMergeRequestRoles>\\n <allowMergeRequestRoles>30</allowMergeRequestRoles>\\n <defaultAssignees>1234</defaultAssignees>\\n </mergeRequestSetting>\\n <testSettingDTO>\\n <isRequired>false</isRequired>\\n <codeGuidelinesDetection>\\n <enabled>false</enabled>\\n <message>test_code_guide_lines</message>\\n </codeGuidelinesDetection>\\n <sensitiveInfoDetection>\\n <enabled>false</enabled>\\n <message>test_code_sensitive_info</message>\\n </sensitiveInfoDetection>\\n <checkTaskQualityConfig>\\n <enabled>false</enabled>\\n <bizNo>123456</bizNo>\\n <taskName>biz-task-quality</taskName>\\n <message>test_task_quality</message>\\n </checkTaskQualityConfig>\\n <checkConfig>\\n <checkItems>\\n <name>api测试-create</name>\\n <isRequired>false</isRequired>\\n </checkItems>\\n </checkConfig>\\n </testSettingDTO>\\n </result>\\n</UpdateProtectedBranchesResponse>","errorExample":""}]', + 'title' => '更改保护分支设置', + 'description' => 'organizationId 和 body中的 branch 参数为必填项。', + 'requestParamsDescription' => '如果只是修改个别字段，请查询后，直接修改查询结果，以查询结果作为参数进行更改。', + ], + 'GetBranchInfo' => [ + 'summary' => '查询代码库分支的信息。', + 'path' => '/repository/{repositoryId}/branches/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5fbe3118672533690be72b12', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'branchName', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'master', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + 'protected' => [ + 'description' => '是否是保护分支', + 'type' => 'string', + 'example' => 'false', + ], + 'commit' => [ + 'description' => '分支最近一次提交信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '修改main.txt文件', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '修改main.txt文件', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 08:00:00', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '阿里云云效Committer', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28056', + ], + 'name' => [ + 'description' => '作者名称', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'testtest', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '提交人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5035', + ], + 'name' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => 'codeup-commit', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'commitcommit', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'signature' => [ + 'description' => '签名信息', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => 'gpg签名的key id', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + 'commentsCount' => [ + 'description' => '评论数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"name\\": \\"master\\",\\n \\"protected\\": \\"false\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"修改main.txt文件\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"修改main.txt文件\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 28056,\\n \\"name\\": \\"codeup-test\\",\\n \\"username\\": \\"testtest\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 5035,\\n \\"name\\": \\"codeup-commit\\",\\n \\"username\\": \\"commitcommit\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n },\\n \\"commentsCount\\": 0\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询分支信息', + ], + 'ListRepositoryBranches' => [ + 'summary' => '查询代码库分支列表。', + 'path' => '/repository/{repositoryId}/branches', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认为 updated_desc'."\n" + .'- updated_desc：按更新时间降序排序'."\n" + .'- updated_asc：按更新时间升序排序', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '具体的提交内容', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 11:00:00', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => 'commit-codeup', + ], + 'parentIds' => [ + 'description' => '父提交ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1F4F342D-493A-5B2C-B133-BA78B30FF834\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"total\\": 100,\\n \\"result\\": [\\n {\\n \\"name\\": \\"testBranch\\",\\n \\"protected\\": \\"false\\",\\n \\"commit\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\",\\n \\"authorName\\": \\"test-codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committedDate\\": \\"2022-03-18 11:00:00\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committerName\\": \\"commit-codeup\\",\\n \\"parentIds\\": [\\n \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询代码库分支列表', + ], + 'ListProtectedBranches' => [ + 'summary' => '查询代码库保护分支列表。', + 'path' => '/repository/{repositoryId}/protect_branches', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '保护分支规则ID', + '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' => '角色'."\n" + .'40：管理员'."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowPushUserIds' => [ + 'description' => '允许推送用户ID', + 'type' => 'array', + 'items' => [ + 'description' => 'Codeup的用户I\'D', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowPushUsers' => [ + 'description' => '允许推送的用户列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'allowMergeRoles' => [ + 'description' => '允许合并角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理者 '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'allowMergeUserIds' => [ + 'description' => '允许合并用户ID', + 'type' => 'array', + 'items' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + ], + 'allowMergeUsers' => [ + 'description' => '允许合并的用户信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'mergeRequestSetting' => [ + 'description' => '合并前的代码评审设置', + 'type' => 'object', + 'properties' => [ + 'isRequired' => [ + 'description' => '是否开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mrMode' => [ + 'description' => '评审模式 '."\n" + .'general：普通 '."\n" + .'codeowner：CodeOwner模式', + 'type' => 'string', + 'example' => 'general', + ], + 'isAllowSelfApproval' => [ + 'description' => '是否允许创建者通过代码评审', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isRequireDiscussionProcessed' => [ + 'description' => '是否要求评审全部已解决', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isResetApprovalWhenNewPush' => [ + 'description' => '是否在有新的提交时重置评审', + 'type' => 'boolean', + 'example' => 'false', + ], + 'minimumApproval' => [ + 'description' => '评审通过的最少人数'."\n" + .'注：仅普通模式生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'allowMergeRequestRoles' => [ + 'description' => '允许合并请求的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '40：管理员（默认） '."\n" + .'30：开发者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[40, 30]', + ], + ], + 'defaultAssignees' => [ + 'description' => '默认评审人', + 'type' => 'array', + 'items' => [ + 'description' => '评审人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'codeup-test', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatar' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + 'whiteList' => [ + 'description' => '评审文件白名单'."\n" + .'注意：加入白名单的文件不受「评审通过的最少人数」限制，无需强制人工评审', + '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' => 'MR卡点流水线配置', + 'type' => 'object', + 'properties' => [ + 'checkItems' => [ + 'description' => '配置项', + 'type' => 'array', + 'items' => [ + 'description' => '配置项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'example' => '测试流水线', + ], + 'isRequired' => [ + 'description' => '是否卡点', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'matches' => [ + 'description' => '保护分支匹配列表', + 'type' => 'array', + 'items' => [ + 'description' => '匹配的分支名称', + 'type' => 'string', + 'example' => '["pb"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"313A1BF6-63B7-52D4-A098-952221A65254\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"branch\\": \\"protectedBranch\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"allowPushRoles\\": [\\n 0\\n ],\\n \\"allowPushUserIds\\": [\\n 19238\\n ],\\n \\"allowPushUsers\\": [\\n {\\n \\"id\\": 19238,\\n \\"name\\": \\"阿里云云效\\",\\n \\"username\\": \\"codeup-test\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"allowMergeRoles\\": [\\n 0\\n ],\\n \\"allowMergeUserIds\\": [\\n 19238\\n ],\\n \\"allowMergeUsers\\": [\\n {\\n \\"id\\": 19238,\\n \\"name\\": \\"阿里云云效\\",\\n \\"username\\": \\"codeup-test\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"mergeRequestSetting\\": {\\n \\"isRequired\\": true,\\n \\"mrMode\\": \\"general\\",\\n \\"isAllowSelfApproval\\": true,\\n \\"isRequireDiscussionProcessed\\": true,\\n \\"isResetApprovalWhenNewPush\\": false,\\n \\"minimumApproval\\": 1,\\n \\"allowMergeRequestRoles\\": [\\n 0\\n ],\\n \\"defaultAssignees\\": [\\n {\\n \\"id\\": 19238,\\n \\"username\\": \\"codeup-test\\",\\n \\"name\\": \\"阿里云云效\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n ],\\n \\"whiteList\\": \\"**.java\\"\\n },\\n \\"testSettingDTO\\": {\\n \\"isRequired\\": false,\\n \\"codeGuidelinesDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_guide_lines\\"\\n },\\n \\"sensitiveInfoDetection\\": {\\n \\"enabled\\": false,\\n \\"message\\": \\"test_code_sensitive_info\\"\\n },\\n \\"checkTaskQualityConfig\\": {\\n \\"enabled\\": false,\\n \\"bizNo\\": \\"123456\\",\\n \\"taskName\\": \\"biz-task-quality\\",\\n \\"message\\": \\"test_task_quality\\"\\n },\\n \\"checkConfig\\": {\\n \\"checkItems\\": [\\n {\\n \\"name\\": \\"测试流水线\\",\\n \\"isRequired\\": false\\n }\\n ]\\n }\\n },\\n \\"matches\\": [\\n \\"[\\\\\\"pb\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询保护分支列表', + ], + 'GetMergeRequest' => [ + 'summary' => '查询单个合并请求详情。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'mrBizId' => [ + 'description' => '合并请求唯一ID', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'localId' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + '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' => '合并请求类型，通常为CODE_REVIEW'."\n" + .'- CODE_REVIEW：代码评审'."\n" + .'- REF_REVIEW：引用评审', + 'type' => 'string', + 'example' => 'CODE_REVIEW', + ], + 'sourceProjectId' => [ + 'description' => '源代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '源分支', + 'type' => 'string', + 'example' => 'test-merge-request', + ], + 'targetProjectId' => [ + 'description' => '目标库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'targetBranch' => [ + 'description' => '目标分支', + 'type' => 'string', + 'example' => 'master', + ], + 'title' => [ + 'description' => '合并请求标题', + 'type' => 'string', + 'example' => 'test-合并请求标题', + ], + 'description' => [ + 'description' => '合并请求描述信息', + 'type' => 'string', + 'example' => 'test-合并请求的具体描述内容', + ], + 'reviewers' => [ + 'description' => '评审人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '评审人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90452', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'hasReviewed' => [ + 'description' => '评审人是否已经评审过', + 'type' => 'boolean', + 'example' => 'false', + ], + 'reviewOpinionStatus' => [ + 'description' => '评审意见，若未评审则为空'."\n" + .'- PASS：通过'."\n" + .'- NOT_PASS：暂不通过', + 'type' => 'string', + 'example' => 'NOT_PASS', + ], + 'reviewTime' => [ + 'description' => '评审人评审完成时间'."\n" + ."\n\n" + .'> 需要确保评审人已经完成评审，否则该值为空', + 'type' => 'string', + 'example' => '2023-05-30T02:53:36Z', + ], + 'hasCommented' => [ + 'description' => '评审人是否发表过评论', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'subscribers' => [ + 'description' => '订阅人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '订阅人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90452', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + ."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'status' => [ + 'description' => '合并请求状态'."\n" + ."\n" + .'- UNDER_DEV：开发中'."\n" + .'- UNDER_REVIEW：评审中'."\n" + .'- TO_BE_MERGED：待合并'."\n" + .'- CLOSED：已关闭'."\n" + .'- MERGED：已合并', + 'type' => 'string', + 'example' => 'UNDER_REVIEW', + ], + 'createFrom' => [ + 'description' => '创建来源'."\n" + .'- WEB：网页UI创建'."\n" + .'- COMMAND_LINE：命令行创建', + 'type' => 'string', + 'example' => 'WEB', + ], + 'ahead' => [ + 'description' => '源分支相较于目标分支多出的commit数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'behind' => [ + 'description' => '目标分支相较于源分支落后的commit数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'todoList' => [ + 'description' => '待办事项', + 'type' => 'object', + 'properties' => [ + 'requirementCheckItems' => [ + 'description' => '卡点项列表', + 'type' => 'array', + 'items' => [ + 'description' => '卡点项信息', + 'type' => 'object', + 'properties' => [ + 'itemType' => [ + 'description' => '卡点项类型'."\n" + .'- MERGE_CONFLICT_CHECK：合并冲突检测'."\n" + .'- COMMENTS_CHECK：评论检查'."\n" + .'- CI_CHECK：自动化检查'."\n" + .'- REVIEWER_APPROVED_CHECK：评审人通过检查', + 'type' => 'string', + 'example' => 'COMMENTS_CHECK', + ], + 'pass' => [ + 'description' => '是否通过卡点项', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'allRequirementsPass' => [ + 'description' => '是否所有卡点通过', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportMergeFastForwardOnly' => [ + 'description' => '是否支持fast-forward-only的合并方式', + 'type' => 'boolean', + 'example' => 'true', + ], + 'detailUrl' => [ + 'description' => '合并请求详情地址', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '页面访问时的URL', + 'type' => 'string', + 'example' => 'xxx', + ], + 'targetProjectNameWithNamespace' => [ + 'description' => '目标库的全名称（含完整组路径）', + 'type' => 'string', + 'example' => 'orgId / test-group / test-target-repo（斜杠两侧有空格）', + ], + 'targetProjectPathWithNamespace' => [ + 'description' => '目标库的全路径（含完整组路径）', + 'type' => 'string', + 'example' => 'orgId/test-group/test-target-repo', + ], + 'mergedRevision' => [ + 'description' => '合并版本（Commit SHA）', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"projectId\\": 2369234,\\n \\"localId\\": 1,\\n \\"createTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"updateTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"mrType\\": \\"CODE_REVIEW\\",\\n \\"sourceProjectId\\": 2369234,\\n \\"sourceBranch\\": \\"test-merge-request\\",\\n \\"targetProjectId\\": 2369234,\\n \\"targetBranch\\": \\"master\\",\\n \\"title\\": \\"test-合并请求标题\\",\\n \\"description\\": \\"test-合并请求的具体描述内容\\",\\n \\"reviewers\\": [\\n {\\n \\"id\\": 90452,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"hasReviewed\\": false,\\n \\"reviewOpinionStatus\\": \\"NOT_PASS\\",\\n \\"reviewTime\\": \\"2023-05-30T02:53:36Z\\",\\n \\"hasCommented\\": true\\n }\\n ],\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"subscribers\\": [\\n {\\n \\"id\\": 90452,\\n \\"name\\": \\"test-subscriber\\",\\n \\"username\\": \\"test-subscriber\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"status\\": \\"UNDER_REVIEW\\",\\n \\"createFrom\\": \\"WEB\\",\\n \\"ahead\\": 1,\\n \\"behind\\": 1,\\n \\"todoList\\": {\\n \\"requirementCheckItems\\": [\\n {\\n \\"itemType\\": \\"COMMENTS_CHECK\\",\\n \\"pass\\": true\\n }\\n ]\\n },\\n \\"allRequirementsPass\\": true,\\n \\"supportMergeFastForwardOnly\\": true,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"xxx\\",\\n \\"targetProjectNameWithNamespace\\": \\"orgId / test-group / test-target-repo（斜杠两侧有空格）\\",\\n \\"targetProjectPathWithNamespace\\": \\"orgId/test-group/test-target-repo\\",\\n \\"mergedRevision\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\"\\n }\\n}","type":"json"}]', + 'title' => '查询合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'ListMergeRequests' => [ + 'summary' => '查询合并请求列表，支持分页、排序和筛选。'."\n" + ."\n" + .'该API能同时查询旧版和新版的合并请求，若没有使用过旧版合并请求，或者已经没有旧版合并请求数据，那么直接忽略返回信息中跟旧版合并请求相关的字段。', + '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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'groupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '代码组ID，支持多个ID，以逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '889910, 889911', + ], + ], + [ + 'name' => 'projectIds', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID，支持多个ID，以逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '2308912, 2308913', + ], + ], + [ + 'name' => 'authorIds', + 'in' => 'query', + 'schema' => [ + 'description' => '创建人阿里云账号ID，支持多个，以逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'reviewerIds', + 'in' => 'query', + 'schema' => [ + 'description' => '评审人阿里云账号ID，支持多个，以逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求状态，默认查询所有状态'."\n" + .'- opened：已开启，包含评审中、待合并、待开发状态'."\n" + .'- closed：已关闭'."\n" + .'- merged：已合并'."\n" + .'- all：所有，若是all，可以不用传值；其他无效字符，也默认查询所有。', + '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' => '排序字段，默认值为updated_at'."\n" + .'- created_at：创建时间'."\n" + .'- updated_at：更新时间'."\n" + ."\n" + .'若传入其他无效字符，默认使用updated_at', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段主要用于过滤新旧版本的合并请求，默认不过滤，同时获取新旧版本的内容，若是一直使用新版合并请求，可忽略该参数。可选值：'."\n" + .'- new：仅查询新版合并请求'."\n" + .'- old：仅查询旧版合并请求', + 'type' => 'string', + 'required' => false, + 'example' => 'new', + ], + ], + [ + 'name' => 'labelIds', + 'in' => 'query', + 'schema' => [ + 'description' => '类标ID列表，多个ID以逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', + ], + ], + [ + 'name' => 'createdBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '起始创建时间'."\n" + ."\n" + .'> ISO 8601格式，如2019-03-15T08:00:00Z，大小比较为 "大于等于"', + 'type' => 'string', + 'required' => false, + 'example' => '2019-03-15T08:00:00Z', + ], + ], + [ + 'name' => 'createdAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '截止创建时间'."\n" + ."\n\n" + .'> ISO 8601格式，如2019-03-15T08:00:00Z，大小比较为 "小于"'."\n" + ."\n\n" + .'> 创建时间范围：[createdBefore, createdAfter)，即左闭右开区间', + 'type' => 'string', + 'required' => false, + 'example' => '2019-03-15T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '合并请求信息', + 'type' => 'object', + 'properties' => [ + 'newMergeRequestIdentifier' => [ + 'description' => '新旧版合并请求的标识，true表示新版，false表示旧版', + 'type' => 'boolean', + 'example' => 'true', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'id' => [ + 'description' => '旧版合并请求的ID，若当前为新版合并请求，那么该值为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'iid' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求；若是新版合并请求，那么该值为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'mrBizId' => [ + 'description' => '新版合并请求的唯一ID，仅新版合并请求会有该值', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'localId' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求，新版合并请求字段', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'title' => [ + 'description' => '合并请求标题', + 'type' => 'string', + 'example' => 'test-合并请求标题', + ], + 'description' => [ + 'description' => '合并请求描述内容', + 'type' => 'string', + 'example' => '描述信息的具体内容'."\n", + ], + 'state' => [ + 'description' => '旧版合并请求状态'."\n" + .'- opened：已开启'."\n" + .'- reopened：重新打开'."\n" + .'- closed：已关闭'."\n" + .'- accepted：评审通过（未合并）'."\n" + .'- merged：评审通过（已合并）'."\n" + .'- locked：合并锁定中', + 'type' => 'string', + 'example' => 'opened', + ], + 'newVersionState' => [ + 'description' => '新版合并请求状态'."\n" + .'- UNDER_DEV：开发中'."\n" + .'- UNDER_REVIEW：评审中'."\n" + .'- TO_BE_MERGED：待合并'."\n" + .'- CLOSED：已关闭'."\n" + .'- MERGED：已合并', + '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' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + ."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'reviewers' => [ + 'description' => '评审人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '评审人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + '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' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '评审人的头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'status' => [ + 'description' => '评审人状态'."\n" + .'- approved：已同意'."\n" + .'- comment：发表过评审'."\n" + .'- pending：还未评审过', + 'type' => 'string', + 'example' => 'approved', + ], + 'reviewTime' => [ + 'description' => '评审人评审完成时间'."\n" + ."\n" + .'> 仅在新版合并请求才有效，且评审人需要完成评审后，该字段才确保存在，否则为空。', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'hasReviewed' => [ + 'description' => '评审人是否已经评审过', + 'type' => 'boolean', + 'example' => 'false', + ], + 'hasCommented' => [ + 'description' => '评审人是否发表过评论', + 'type' => 'boolean', + 'example' => 'true', + ], + 'reviewOpinionStatus' => [ + 'description' => '评审意见，若未评审则为空'."\n" + .'- PASS：通过'."\n" + .'- NOT_PASS：暂不通过', + 'type' => 'string', + 'example' => 'PASS', + ], + ], + ], + ], + 'subscribers' => [ + 'description' => '订阅人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '订阅人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876119', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-subscriber', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'root-test-subscriber', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + ."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'sourceProjectId' => [ + 'description' => '源代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2876119', + ], + 'targetProjectId' => [ + 'description' => '目标库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2876119', + ], + 'workInProgress' => [ + 'description' => '是否在开发中', + 'type' => 'boolean', + 'example' => 'false', + ], + 'detailUrl' => [ + 'description' => '合并请求详情地址', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'sshUrl' => [ + 'description' => '代码库的SSH克隆地址', + 'type' => 'string', + 'example' => 'git@xxx:xxx/test/test.git', + ], + 'creationMethod' => [ + 'description' => '创建方式'."\n" + .'- WEB：网页UI创建'."\n" + .'- COMMAND_LINE：命令行创建', + 'type' => 'string', + 'example' => 'WEB', + ], + 'sourceType' => [ + 'description' => '若是旧版合并请求，枚举值为'."\n" + .'- BRANCH：分支'."\n" + .'- COMMIT：提交'."\n" + ."\n" + .'若是新版合并请求，枚举值为'."\n" + .'- BRANCH：分支'."\n" + .'- REF：提交或者引用评审', + 'type' => 'string', + 'example' => 'BRANCH', + ], + 'targetType' => [ + 'description' => '目标类型通常为 BRANCH', + 'type' => 'string', + 'example' => 'BRANCH', + ], + 'nameWithNamespace' => [ + 'description' => '代码库完整名称（含完整组名称）', + 'type' => 'string', + 'example' => 'codeup-test-org / test-create-group （斜杠两侧有空格）', + ], + 'supportMergeFFOnly' => [ + 'description' => '是否支持fast-forward-only合并方式', + 'type' => 'boolean', + 'example' => 'true', + ], + 'labels' => [ + 'description' => '类标列表', + 'type' => 'array', + 'items' => [ + 'description' => '类标信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '类标 ID，唯一标识', + 'type' => 'string', + 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', + ], + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'example' => '新特性', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'example' => '#006AD4', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'example' => '新的特性或需求', + ], + ], + ], + ], + 'mergedRevision' => [ + 'description' => '合并版本（Commit SHA）', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"newMergeRequestIdentifier\\": true,\\n \\"projectId\\": 2369234,\\n \\"id\\": 1,\\n \\"iid\\": 1,\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"localId\\": 2,\\n \\"title\\": \\"test-合并请求标题\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"state\\": \\"opened\\",\\n \\"newVersionState\\": \\"UNDER_REVIEW\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"sourceBranch\\": \\"test-merge-source-branch\\",\\n \\"targetBranch\\": \\"test-merge-target-branch\\",\\n \\"author\\": {\\n \\"id\\": 19927,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"reviewers\\": [\\n {\\n \\"id\\": 43127,\\n \\"name\\": \\"test-review-user\\",\\n \\"username\\": \\"root-test-review-user\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"status\\": \\"approved\\",\\n \\"reviewTime\\": \\"2022-03-18 14:24:54\\",\\n \\"hasReviewed\\": false,\\n \\"hasCommented\\": true,\\n \\"reviewOpinionStatus\\": \\"PASS\\"\\n }\\n ],\\n \\"subscribers\\": [\\n {\\n \\"id\\": 1876119,\\n \\"name\\": \\"test-subscriber\\",\\n \\"username\\": \\"root-test-subscriber\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"sourceProjectId\\": 2876119,\\n \\"targetProjectId\\": 2876119,\\n \\"workInProgress\\": false,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"sshUrl\\": \\"git@xxx:xxx/test/test.git\\",\\n \\"creationMethod\\": \\"WEB\\",\\n \\"sourceType\\": \\"BRANCH\\",\\n \\"targetType\\": \\"BRANCH\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"supportMergeFFOnly\\": true,\\n \\"labels\\": [\\n {\\n \\"id\\": \\"b5b5738b94954bc6aa5a293316ed1d24\\",\\n \\"name\\": \\"新特性\\",\\n \\"color\\": \\"#006AD4\\",\\n \\"description\\": \\"新的特性或需求\\"\\n }\\n ],\\n \\"mergedRevision\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询合并请求列表', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'CreateMergeRequest' => [ + 'summary' => '创建合并请求。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '6270e731cfea268afc21ccac', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'sourceProjectId' => [ + 'description' => '源代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '源分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'sourceBranch', + ], + 'targetProjectId' => [ + 'description' => '目标代码库ID', + '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' => '创建来源，固定取值为：WEB', + 'type' => 'string', + 'required' => true, + 'example' => 'WEB', + ], + 'description' => [ + 'description' => '合并请求描述信息', + 'type' => 'string', + 'required' => false, + 'example' => '测试合并请求', + ], + 'reviewerIds' => [ + 'description' => '评审人阿里云账号ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + 'required' => false, + ], + 'workItemIds' => [ + 'description' => '关联工作项ID，支持多个，以逗号隔开', + 'type' => 'string', + 'required' => false, + 'example' => '722200214032b6b31e6f1434ab', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '合并请求唯一ID', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'localId' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + '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' => '合并请求类型，固定为：CODE_REVIEW', + 'type' => 'string', + 'example' => 'CODE_REVIEW', + ], + 'sourceProjectId' => [ + 'description' => '评审分支所在的代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'sourceBranch' => [ + 'description' => '源分支名称', + 'type' => 'string', + 'example' => 'sourceBranch', + ], + 'targetProjectId' => [ + 'description' => '目标分支所在的代码库ID', + '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' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7905', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '企业登录名', + 'type' => 'string', + 'example' => 'root-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '评审人的头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'hasReviewed' => [ + 'description' => '评审人是否已经评审过', + 'type' => 'boolean', + 'example' => 'false', + ], + 'reviewOpinionStatus' => [ + 'description' => '评审意见'."\n" + .'- PASS：通过'."\n" + .'- NOT_PASS：暂不通过', + 'type' => 'string', + 'example' => 'PASS', + ], + ], + ], + ], + 'author' => [ + 'description' => '创建人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup-nickname', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'subscribers' => [ + 'description' => '订阅人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '订阅人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10092', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'root-test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + ."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'status' => [ + 'description' => '合并请求状态'."\n" + .'- UNDER_DEV：开发中'."\n" + .'- UNDER_REVIEW：评审中'."\n" + .'- TO_BE_MERGED：待合并'."\n" + .'- CLOSED：已关闭'."\n" + .'- MERGED：已合并', + 'type' => 'string', + 'example' => 'UNDER_REVIEW', + ], + 'createFrom' => [ + 'description' => '创建来源，取值为：WEB', + 'type' => 'string', + 'example' => 'WEB', + ], + 'ahead' => [ + 'description' => '源分支相较于目标分支多出的commit数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'behind' => [ + 'description' => '目标分支相较于源分支落后的commit数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'detailUrl' => [ + 'description' => '详情页地址', + 'type' => 'string', + 'example' => 'xxx', + ], + 'webUrl' => [ + 'description' => '合并请求的web地址', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/xxx/test/test'."\n", + ], + 'allRequirementsPass' => [ + 'description' => '是否所有卡点通过', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportMergeFastForwardOnly' => [ + 'description' => '是否支持fast-forward-only的合并方式', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"mrBizId\\": \\"bca90244c4b749e0b109df52ac0eb570\\",\\n \\"projectId\\": 2369234,\\n \\"localId\\": 1,\\n \\"createTime\\": \\"2023-06-02T03:41:22Z\\",\\n \\"updateTime\\": \\"2023-06-02T03:41:22Z\\",\\n \\"mrType\\": \\"CODE_REVIEW\\",\\n \\"sourceProjectId\\": 2369234,\\n \\"sourceBranch\\": \\"sourceBranch\\",\\n \\"targetProjectId\\": 2369234,\\n \\"targetBranch\\": \\"targetBranch\\",\\n \\"title\\": \\"测试合并请求的标题\\",\\n \\"description\\": \\"测试合并请求\\",\\n \\"reviewers\\": [\\n {\\n \\"id\\": 7905,\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"root-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"hasReviewed\\": false,\\n \\"reviewOpinionStatus\\": \\"PASS\\"\\n }\\n ],\\n \\"author\\": {\\n \\"id\\": 19230,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup-nickname\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"subscribers\\": [\\n {\\n \\"id\\": 10092,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"root-test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ],\\n \\"status\\": \\"UNDER_REVIEW\\",\\n \\"createFrom\\": \\"WEB\\",\\n \\"ahead\\": 2,\\n \\"behind\\": 0,\\n \\"detailUrl\\": \\"xxx\\",\\n \\"webUrl\\": \\"https://codeup.aliyun.com/xxx/test/test\\\\n\\",\\n \\"allRequirementsPass\\": true,\\n \\"supportMergeFastForwardOnly\\": true\\n }\\n}","type":"json"}]', + 'title' => '创建合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'UpdateMergeRequest' => [ + 'summary' => '该API仅支持修改合并请求的标题和描述信息。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '合并请求标题', + 'type' => 'string', + 'required' => false, + 'example' => 'test-更新标题', + ], + 'description' => [ + 'description' => '合并请求描述信息', + 'type' => 'string', + 'required' => false, + 'example' => 'test-描述信息', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '更新是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '更新合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'UpdateMergeRequestPersonnel' => [ + 'summary' => '更新合并请求的干系人，包含评审人、订阅人。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/person/{personType}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1233456', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'personType', + 'in' => 'path', + 'schema' => [ + 'description' => '干系人的类型'."\n" + ."\n" + .'- REVIEWER：评审人'."\n" + .'- SUBSCRIBER：关注人', + 'type' => 'string', + 'required' => true, + 'example' => 'REVIEWER', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'newUserIdList' => [ + 'description' => '干系人的阿里云账号ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '249286812078239123', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '修改干系人是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '更新合并请求的干系人', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'MergeMergeRequest' => [ + 'summary' => '合并当前合并请求。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/merge', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'mergeType' => [ + 'description' => '合并方式'."\n" + .'- no-fast-forward：默认合并方式，创建一个合并节点合并'."\n" + .'- squash：压缩合并方式'."\n" + .'- rebase：rebase合并'."\n" + .'- ff-only：fast-forward-only合并请求', + 'type' => 'string', + 'required' => true, + 'example' => 'no-fast-forward', + ], + 'mergeMessage' => [ + 'description' => '合并提交信息', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'removeSourceBranch' => [ + 'description' => '是否在合并后删除评审分支', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9ED5E382-3A58-51E4-8A81-CE25D1756025', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '合并请求是否成功', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mergedRevision' => [ + 'description' => '合并版本（Commit SHA）', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'bizId' => [ + 'description' => '合并请求业务ID', + 'type' => 'string', + 'example' => 'bca90244c4b749e0b109df52ac0eb570', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'localId' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + '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' => '合并合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'ReviewMergeRequest' => [ + 'summary' => '评审合并请求，发表评审意见。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/submit_review_opinion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2334743', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'reviewOpinion' => [ + 'description' => '评审意见'."\n" + .'- PASS：通过'."\n" + .'- NOT_PASS：不通过', + 'type' => 'string', + 'required' => true, + 'example' => 'PASS', + ], + 'reviewComment' => [ + 'description' => '评审发表的评论意见', + 'type' => 'string', + 'required' => false, + 'example' => '评论意见具体内容', + ], + 'draftCommentIds' => [ + 'description' => '一起提交的草稿评论的ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '草稿评论ID', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '评审是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '评审合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'CloseMergeRequest' => [ + 'summary' => '关闭指定的合并请求。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/close', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'InvalidParam.NoPermission', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '关闭是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"InvalidParam.NoPermission\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '关闭合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'ReopenMergeRequest' => [ + 'summary' => '对关闭的合并请求重新打开，其中已合并的合并请求无法执行重新代开操作。', + 'path' => '/api/v4/projects/{repositoryId}/merge_requests/{localId}/reopen', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2464454', + ], + ], + [ + 'name' => 'localId', + 'in' => 'path', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '313A1BF6-63B7-52D4-A098-952221A65254', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '重新打开是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"313A1BF6-63B7-52D4-A098-952221A65254\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '重新开启合并请求', + 'description' => '该接口需要确保当前企业已经在使用新版MR，具体可看当前企业的合并请求页面是否已是新版本。', + ], + 'ListMergeRequestPatchSets' => [ + 'summary' => '查询合并请求下的所有版本信息，包括合并源的版本和合并目标的版本。', + 'path' => '/api/v4/projects/merge_requests/diffs/list_patchsets', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo'."\n", + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '版本号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '版本的业务ID，具有唯一性和业务实义，在涉及版本ID的传参处，均使用该ID', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本1', + ], + 'commitId' => [ + 'description' => '版本关联的提交ID', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortCommitId' => [ + 'description' => '提交短ID', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '关联的合并类型'."\n" + .'- MERGE_SOURCE：合并源'."\n" + .'- MERGE_TARGET：合并目标', + 'type' => 'string', + 'example' => 'MERGE_SOURCE', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"patchSetNo\\": 1,\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortCommitId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询合并请求版本列表', + 'description' => '版本表达的概念类似于一次推送，每个版本会关联一个Commit SHA；一次推送可能会包括多个提交，此时关联的提交ID为推送的最新提交。', + ], + 'GetMergeRequestChangeTree' => [ + 'summary' => '查询合并请求的Diff统计信息，包括总变更文件树、总新增行、总删减行以及每个文件的新增行与删减行。', + '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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo'."\n", + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并目标的版本业务ID'."\n" + ."\n" + .'> 关于from和to，在合并请求以及比较相关的接口中，from和to与常识是相反的，即 from应该是合并目标，to才是合并源，该顺序符合实际Git执行时的顺序，页面UI的源和目标实际上是经过处理后的，才会符合直觉。', + 'type' => 'string', + 'required' => true, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并源的版本业务ID'."\n" + ."\n" + .'> 关于from和to，在合并请求以及比较相关的接口中，from和to与常识是相反的，即 from应该是合并目标，to才是合并源，该顺序符合实际Git执行时的顺序，页面UI的源和目标实际上是经过处理后的，才会符合直觉。', + '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' => '请求ID', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'changedFilesCount' => [ + 'description' => '总变更文件数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'totalAddLines' => [ + 'description' => '总新增行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'totalDelLines' => [ + 'description' => '总删除行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'changedFilesInfos' => [ + 'description' => '变更文件信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个变更文件统计信息', + 'type' => 'object', + 'properties' => [ + 'newPath' => [ + 'description' => '新文件路径', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'oldPath' => [ + 'description' => '旧文件路径', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'newFile' => [ + 'description' => '是否是新增文件', + 'type' => 'boolean', + 'example' => 'true', + ], + 'renamedFile' => [ + 'description' => '是否是重命名文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deletedFile' => [ + 'description' => '是否是删除文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'binaryFile' => [ + 'description' => '是否是二进制文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'addLines' => [ + 'description' => '变更文件新增行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'delLines' => [ + 'description' => '变更文件删除行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"changedFilesCount\\": 20,\\n \\"totalAddLines\\": 100,\\n \\"totalDelLines\\": 50,\\n \\"changedFilesInfos\\": [\\n {\\n \\"newPath\\": \\"test.txt\\",\\n \\"oldPath\\": \\"test.txt\\",\\n \\"newFile\\": true,\\n \\"renamedFile\\": false,\\n \\"deletedFile\\": false,\\n \\"binaryFile\\": false,\\n \\"addLines\\": 10,\\n \\"delLines\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询合并请求Diff统计信息', + ], + 'ListMergeRequestFilesReads' => [ + 'summary' => '查询合并请求变更文件的已读情况，主要获取变更文件的已读人列表。', + 'path' => '/api/v4/projects/merge_requests/diffs/files_read_infos', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'agp_4d57a6796b3626f52064ab1fba5384a5', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'fromPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并目标的版本业务ID'."\n" + ."\n" + .'> 关于from和to，在合并请求以及比较相关的接口中，from和to与常识是相反的，即 from应该是合并目标，to才是合并源，该顺序符合实际Git执行时的顺序，页面UI的源和目标实际上是经过处理后的，才会符合直觉。', + 'type' => 'string', + 'required' => true, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + ], + [ + 'name' => 'toPatchSetBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并源的版本业务ID'."\n" + ."\n" + .'> 关于from和to，在合并请求以及比较相关的接口中，from和to与常识是相反的，即 from应该是合并目标，to才是合并源，该顺序符合实际Git执行时的顺序，页面UI的源和目标实际上是经过处理后的，才会符合直觉。', + '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' => '请求ID', + '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' => '阿里云账号ID', + 'type' => 'string', + 'example' => '204485087002425236', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态'."\n" + .'- active：活跃'."\n" + .'- blocked：暂不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '用户头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"oldFilePath\\": \\"text.txt\\",\\n \\"newFilePath\\": \\"text.txt\\",\\n \\"newFile\\": true,\\n \\"renamedFile\\": \\"false\\",\\n \\"deletedFile\\": \\"false\\",\\n \\"readUsers\\": [\\n {\\n \\"aliyunPk\\": \\"204485087002425236\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询合并请求变更文件已读情况', + ], + 'ListMergeRequestComments' => [ + 'summary' => '查询合并请求中的评论列表，不分页。其中，评论仅支持三级结构。', + 'path' => '/api/v4/projects/merge_requests/comments/list_comments', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'patchSetBizIds' => [ + 'description' => '版本业务ID列表'."\n" + ."\n" + .'> 每个评论会关联一个版本，表示该评论发表在第几个版本，其中对于全局评论，关联的是最新的合并源版本。', + 'type' => 'array', + 'items' => [ + 'description' => '版本业务ID', + 'type' => 'string', + 'required' => false, + 'example' => '5e733626d53f4b04a6aa0e23d4ff72b8', + ], + 'required' => false, + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL_COMMENT', + ], + 'filePath' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => false, + 'example' => '/src/main/test.java', + ], + 'state' => [ + 'description' => '评论状态'."\n" + ."\n" + .'- DRAFT：草稿状态'."\n" + .'- OPENED：已发表或者开启', + 'type' => 'string', + 'required' => false, + 'example' => 'OPENED', + ], + 'resolved' => [ + 'description' => '是否已解决', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '返回结果'."\n" + ."\n\n" + .'><notice>评论对象，仅支持三层结构；若使用了超过三层结构的评论，将不会返回相应的数据。></notice>', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '评论唯一业务ID', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '评论状态'."\n" + ."\n" + .'- DRAFT：草稿状态'."\n" + .'- OPENED：已发表或者开启', + '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' => '{\\"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\\"]]]]}', + ], + 'author' => [ + 'description' => '评论人信息', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '284692704493684695', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态'."\n" + ."\n" + .'- active：活跃'."\n" + .'- blocked：暂不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'description' => '主键ID，无业务实义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '关联的版本信息', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '版本的唯一业务ID', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本1', + ], + 'commitId' => [ + 'description' => '版本关联的提交ID', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '关联的合并类型'."\n" + .'- MERGE_SOURCE：合并源'."\n" + .'- MERGE_TARGET：合并目标', + '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' => '父评论业务ID', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '根评论业务ID', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + 'childComments' => [ + 'description' => '子评论列表', + 'type' => 'array', + 'items' => [ + 'description' => '子评论信息', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '评论唯一业务ID', + 'type' => 'string', + 'example' => '63f0e293357f48f9846ddc4dbbebd0e3', + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '评论状态'."\n" + ."\n" + .'- DRAFT：草稿状态'."\n" + .'- OPENED：已发表或者开启', + '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' => '{\\"htmlValue\\":\\"'."\n" + .'测试动态创建整体评论-2'."\n" + ."\n" + .'\\",\\"jsonMLValue\\":[\\"root\\",{},[\\"p\\",{},[\\"span\\",{\\"data-type\\":\\"text\\"},[\\"span\\",{\\"data-type\\":\\"leaf\\"},\\"测试动态创建整体评论-2\\"]]]]}', + ], + 'author' => [ + 'description' => '评论人信息', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '204485087002425236', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态'."\n" + ."\n" + .'- active：活跃'."\n" + .'- blocked：暂不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'id' => [ + 'description' => '主键ID，无业务实义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132582', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '关联的版本信息', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '版本的唯一业务ID', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本1'."\n", + ], + 'commitId' => [ + 'description' => '版本关联的提交ID', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '关联的合并类型'."\n" + ."\n" + .'- MERGE_SOURCE：合并源'."\n" + .'- MERGE_TARGET：合并目标', + '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' => '父评论业务ID', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'rootCommentBizId' => [ + 'description' => '父评论业务ID', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + 'finalChildComments' => [ + 'description' => '最后层级子评论列表', + 'type' => 'array', + 'items' => [ + 'description' => '评论信息', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '评论唯一业务ID', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '评论状态'."\n" + ."\n" + .'- DRAFT：草稿状态'."\n" + .'- OPENED：已发表或者开启', + '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' => '{\\"htmlValue\\":\\"'."\n" + .'测试动态创建整体评论-2'."\n" + ."\n" + .'\\",\\"jsonMLValue\\":[\\"root\\",{},[\\"p\\",{},[\\"span\\",{\\"data-type\\":\\"text\\"},[\\"span\\",{\\"data-type\\":\\"leaf\\"},\\"测试动态创建整体评论-2\\"]]]]}', + ], + 'author' => [ + 'description' => '评论人信息', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '235671547828975455', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态'."\n" + ."\n" + .'- active：活跃'."\n" + .'- blocked：暂不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'id' => [ + 'description' => '主键ID，无业务实义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '567035', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '关联的版本信息', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '版本的唯一业务ID', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本1', + ], + 'commitId' => [ + 'description' => '版本关联的提交ID', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '关联的合并类型'."\n" + ."\n" + .'- MERGE_SOURCE：合并源'."\n" + .'- MERGE_TARGET：合并目标', + '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' => '父评论业务ID', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '根评论业务ID', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"56C33A95-C04F-59F0-B3CD-E2A2EB9FADBB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"<article class=\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"4ever-article\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"><p style=\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text-align:left;text-indent:0;margin-left:0\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"><span>测试动态创建整体评论-2</span></p></article>\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"284692704493684695\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"id\\": 19230\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\",\\n \\"childComments\\": [\\n {\\n \\"commentBizId\\": \\"63f0e293357f48f9846ddc4dbbebd0e3\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\n测试动态创建整体评论-2\\\\n\\\\n\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"204485087002425236\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\\\n\\",\\n \\"id\\": 132582\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\\\n\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\\\n\\",\\n \\"parentCommentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\",\\n \\"finalChildComments\\": [\\n {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\",\\n \\"content\\": \\"{\\\\\\\\\\\\\\"htmlValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\n测试动态创建整体评论-2\\\\n\\\\n\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jsonMLValue\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"root\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"p\\\\\\\\\\\\\\",{},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},[\\\\\\\\\\\\\\"span\\\\\\\\\\\\\\",{\\\\\\\\\\\\\\"data-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"测试动态创建整体评论-2\\\\\\\\\\\\\\"]]]]}\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"235671547828975455\\",\\n \\"name\\": \\"codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\\\n\\",\\n \\"id\\": 567035\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/test.java\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\\\n\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询合并请求评论列表', + ], + 'CreateComment' => [ + 'summary' => '创建合并请求评论，可创建整体评论和行内评论。创建的评论层级一般不要超过3层。', + 'path' => '/api/v4/projects/code_reviews/comments/create_comment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '214317', + 'abilityTreeNodes' => [ + 'FEATURErdcI7YZMH', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '评论内容', + 'type' => 'string', + 'required' => true, + 'example' => '评论内容', + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'required' => true, + 'example' => 'GLOBAL_COMMENT', + ], + 'parentCommentBizId' => [ + 'description' => '父评论业务ID', + 'type' => 'string', + 'required' => false, + 'example' => '2666ac1ac53841b0ba1b042e383279cc', + ], + 'resolved' => [ + 'description' => '是否已解决'."\n" + ."\n" + .'><notice>若是父评论业务ID为空，即创建根评论时，必须设置resolved的值></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'filePath' => [ + 'description' => '文件路径'."\n" + ."\n\n" + .'> 当commentType=INLINE_COMMENT时，才需要传入值', + 'type' => 'string', + 'required' => false, + 'example' => '/src/main/test.java', + ], + 'lineNumber' => [ + 'description' => '评论所在的文件行号，仅文件行内评论才有', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '关联的合并请求版本ID'."\n" + .'<notice>若是创建INLINE_COMMENT类型的评论，则该值必传></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'b7d8386be17c4ca68a07140db4836257', + ], + 'draft' => [ + 'description' => '是否是草稿评论', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'fromPachSetBizId' => [ + 'description' => '比较起始的版本ID'."\n" + ."\n" + .'<notice>若是创建INLINE_COMMENT类型的评论，则该值必传></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'b7d8386be17c4ca68a07140db4836257', + ], + 'toPatchSetBizId' => [ + 'description' => '比较目标的版本ID'."\n" + ."\n" + .'<notice>若是创建INLINE_COMMENT类型的评论，则该值必传></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '543cd42cbfc0447b920a670e9897b6f7', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'commentBizId' => [ + 'description' => '评论唯一业务ID', + 'type' => 'string', + 'example' => '5c399e3685e542a28db16d93e9f82abb', + ], + 'commentType' => [ + 'description' => '评论类型'."\n" + ."\n" + .'- GLOBAL_COMMENT：全局评论'."\n" + .'- INLINE_COMMENT：文件行内评论', + 'type' => 'string', + 'example' => 'GLOBAL_COMMENT', + ], + 'state' => [ + 'description' => '评论状态'."\n" + ."\n" + .'- DRAFT：草稿状态'."\n" + .'- OPENED：已发表或者开启', + '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' => '阿里云账号ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active - 可用状态'."\n" + .'- blocked - 废弃或不可用', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => '头像地址'."\n" + ."\n" + .'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'id' => [ + 'description' => '主键ID，无业务实义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19927', + ], + ], + ], + 'relatedPatchSet' => [ + 'description' => '关联的版本信息', + 'type' => 'object', + 'properties' => [ + 'patchSetNo' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1', + ], + 'patchSetBizId' => [ + 'description' => '版本的唯一业务ID', + 'type' => 'string', + 'example' => '513fcfd81a9142d2bb0db4f72c0aa15b', + ], + 'patchSetName' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本1', + ], + 'commitId' => [ + 'description' => '版本关联的提交ID', + 'type' => 'string', + 'example' => '1a072f5367c21f9de3464b8c0ee8546e47764d2d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => '1a072f53', + ], + 'relatedMergeItemType' => [ + 'description' => '关联的合并类型'."\n" + .'- MERGE_SOURCE：合并源'."\n" + .'- MERGE_TARGET：合并目标', + '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' => '文件路径，仅commentType=INLINE_COMMENT时才有', + 'type' => 'string', + 'example' => 'src/main/update.txt', + ], + 'parentCommentBizId' => [ + 'description' => '父评论业务ID', + 'type' => 'string', + 'example' => '4c5dcec6a8dc41e69c369737dadc1841', + ], + 'rootCommentBizId' => [ + 'description' => '根评论业务ID', + 'type' => 'string', + 'example' => 'dcf2b23cebfc418f98dbd35e423d9fd3', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"commentBizId\\": \\"5c399e3685e542a28db16d93e9f82abb\\",\\n \\"commentType\\": \\"GLOBAL_COMMENT\\",\\n \\"state\\": \\"OPENED\\",\\n \\"resolved\\": false,\\n \\"deleted\\": false,\\n \\"commentTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastEditTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"content\\": \\"xxxx\\",\\n \\"author\\": {\\n \\"aliyunPk\\": \\"xxx\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"头像地址\\\\n\\\\nhttps://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"id\\": 19927\\n },\\n \\"relatedPatchSet\\": {\\n \\"patchSetNo\\": \\"1\\",\\n \\"patchSetBizId\\": \\"513fcfd81a9142d2bb0db4f72c0aa15b\\",\\n \\"patchSetName\\": \\"版本1\\",\\n \\"commitId\\": \\"1a072f5367c21f9de3464b8c0ee8546e47764d2d\\",\\n \\"shortId\\": \\"1a072f53\\",\\n \\"relatedMergeItemType\\": \\"MERGE_SOURCE\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\\\n\\"\\n },\\n \\"lineNumber\\": \\"3\\",\\n \\"filePath\\": \\"src/main/update.txt\\",\\n \\"parentCommentBizId\\": \\"4c5dcec6a8dc41e69c369737dadc1841\\",\\n \\"rootCommentBizId\\": \\"dcf2b23cebfc418f98dbd35e423d9fd3\\"\\n }\\n}","type":"json"}]', + 'title' => '创建合并请求评论', + ], + 'GetCompareDetail' => [ + 'summary' => '比较两个commit（branch和tag本质也是commit），返回两个commit之间的commits列表以及diff内容（可从diff内容中获取到文件变更树）。', + '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' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'from', + 'in' => 'query', + 'schema' => [ + 'description' => '起始版本（指commitId）', + 'type' => 'string', + 'required' => true, + 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', + ], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => [ + 'description' => '截止版本（指commitId）', + 'type' => 'string', + 'required' => true, + 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', + ], + ], + [ + 'name' => 'mergeBase', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用merge-base进行比较', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'maxDiffFile', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的最大文件数量'."\n" + ."\n" + .'> 限制最大安全返回的文件数量为5000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5000', + ], + ], + [ + 'name' => 'maxDiffByte', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的最大diff字节数'."\n" + ."\n" + .'> 限制最大返回的字节数为24MB', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24 * 1024 * 1024', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息'."\n" + ."\n", + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'messages' => [ + 'description' => '说明列表', + 'type' => 'array', + 'items' => [ + 'description' => '说明内容', + 'type' => 'string', + 'example' => '""', + ], + ], + 'commits' => [ + 'description' => '差异提交列表', + 'type' => 'array', + 'items' => [ + 'description' => '提交内容', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'b8f6f28520b1936aafe2e638373e19ccafa42b02', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'b8f6f285', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '""', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '云效Codeup', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2023-01-03T15:41:26+08:00', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-01-03T15:41:26+08:00', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '云效CodeupCommitter', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2023-01-03T15:41:26+08:00', + ], + 'parentIds' => [ + 'description' => '父提交ID', + 'type' => 'array', + 'items' => [ + 'description' => '父提交Id', + 'type' => 'string', + 'example' => 'c9fb781f3d66ef6ee60bdd5c414f5106454b1426', + ], + ], + 'author' => [ + 'description' => '作者信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21396', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => '云效', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'committer' => [ + 'description' => '提交人信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43910', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => '云效Committer', + ], + 'username' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'Codeup-commiter', + ], + 'state' => [ + 'description' => '状态'."\n" + .'可选值：active / blocked，默认值active', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'commentsCount' => [ + 'description' => '评论数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'diffs' => [ + 'description' => 'Diff文件内容', + 'type' => 'array', + 'items' => [ + 'description' => 'diff内容', + 'type' => 'object', + 'properties' => [ + 'diff' => [ + 'description' => 'diff内容', + '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', + ], + 'newPath' => [ + 'description' => '新文件路径', + 'type' => 'string', + 'example' => 'new_test.txt', + ], + 'oldPath' => [ + 'description' => '旧文件路径', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'aMode' => [ + 'description' => '旧路径的文件模式标识，包含文件类型、权限等信息，如100644为正常文件, 100755为可执行文件', + 'type' => 'string', + 'example' => '100644', + ], + 'bMode' => [ + 'description' => '新路径的文件模式标识，包含文件类型、权限等信息，如100644为正常文件, 100755为可执行文件', + 'type' => 'string', + 'example' => '100644', + ], + 'newFile' => [ + 'description' => '是否是新增文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'renamedFile' => [ + 'description' => '是否是重命名文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deletedFile' => [ + 'description' => '是否是删除文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isBinary' => [ + 'description' => '是否二进制文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'oldId' => [ + 'description' => '旧文件的git object id', + 'type' => 'string', + 'example' => '6c268061a546378276559c713d0ad377d4dsjfh', + ], + 'newId' => [ + 'description' => '新文件的git object id', + 'type' => 'string', + 'example' => 'cb75846da2df3d3d7f290c3569236fcf3dd17224', + ], + 'isNewLfs' => [ + 'description' => '新文件是否是大文件（LFS）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isOldLfs' => [ + 'description' => '旧文件是否是大文件（LFS）', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"messages\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"commits\\": [\\n {\\n \\"id\\": \\"b8f6f28520b1936aafe2e638373e19ccafa42b02\\",\\n \\"shortId\\": \\"b8f6f285\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"authorName\\": \\"云效Codeup\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"createdAt\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"committerName\\": \\"云效CodeupCommitter\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2023-01-03T15:41:26+08:00\\",\\n \\"parentIds\\": [\\n \\"c9fb781f3d66ef6ee60bdd5c414f5106454b1426\\"\\n ],\\n \\"author\\": {\\n \\"id\\": 21396,\\n \\"name\\": \\"云效\\",\\n \\"username\\": \\"Codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"externUid\\": \\"5f969843cd2214ba0e24327d\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"websiteUrl\\": \\"“”\\"\\n },\\n \\"committer\\": {\\n \\"id\\": 43910,\\n \\"name\\": \\"云效Committer\\",\\n \\"username\\": \\"Codeup-commiter\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"externUid\\": \\"5f969843cd2214ba0e24327d\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"websiteUrl\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"commentsCount\\": 1\\n }\\n ],\\n \\"diffs\\": [\\n {\\n \\"diff\\": \\"--- /dev/null\\\\\\\\n+++ b/mr_error.txt\\\\\\\\n@@ -0,0 +1,3 @@\\\\\\\\n+first\\\\\\\\n+\\\\\\\\n+提交2\\\\\\\\n\\\\\\\\\\\\\\\\ No newline at end of file\\\\\\\\n\\",\\n \\"newPath\\": \\"new_test.txt\\",\\n \\"oldPath\\": \\"test.txt\\",\\n \\"aMode\\": \\"100644\\",\\n \\"bMode\\": \\"100644\\",\\n \\"newFile\\": false,\\n \\"renamedFile\\": false,\\n \\"deletedFile\\": false,\\n \\"isBinary\\": false,\\n \\"oldId\\": \\"6c268061a546378276559c713d0ad377d4dsjfh\\",\\n \\"newId\\": \\"cb75846da2df3d3d7f290c3569236fcf3dd17224\\",\\n \\"isNewLfs\\": false,\\n \\"isOldLfs\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Compare接口', + ], + 'CreateCommitStatus' => [ + 'summary' => '给指定的Commit添加一条提交状态记录。', + 'path' => '/api/v4/projects/repository/commit_statuses/create_commit_status', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'description' => '仅支持提交ID，即Commit SHA', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c1a1299a2656bfc155650bbd2df5e628fa1f4c', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'description' => '写入状态，且仅能填入以下四个字符串，否则会返回错误。'."\n" + .'- error：异常'."\n" + .'- failure：失败'."\n" + .'- pending：运行中'."\n" + .'- success：成功', + 'type' => 'string', + 'required' => true, + 'example' => 'success', + ], + 'description' => [ + 'description' => '提交状态的简要描述，且不能超过3000个字符', + 'type' => 'string', + 'required' => false, + 'example' => '提交状态描述内容', + ], + 'targetUrl' => [ + 'description' => '用户自行写入的跳转链接，代码平台仅提供跳转的UI，一般可设置为三方系统的链接', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'context' => [ + 'description' => '用于区分不同系统写入的字符串标识，会以标题的作用在相应的页面UI处进行展示，默认为default，长度不超过50，且英文大小写不敏感'."\n" + ."\n" + .'> 该参数在设置卡点和合并请求联动中非常重要，若非测试调试，切勿随意设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => 'ID（无业务实际意义）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'sha' => [ + 'description' => '提交ID，即Commit SHA', + 'type' => 'string', + 'example' => 'c0ca103441b9fa7f369be8d24a6f20db44dfddf7', + ], + 'context' => [ + 'description' => '用于区分不同系统写入的字符串标识，会以标题的作用在相应的页面UI处进行展示，默认为default，长度不超过50，且英文大小写不敏感', + 'type' => 'string', + 'example' => 'default', + ], + 'state' => [ + 'description' => '写入状态'."\n" + .'- error：异常'."\n" + .'- failure：失败'."\n" + .'- pending：运行中'."\n" + .'- success：成功', + 'type' => 'string', + 'example' => 'success', + ], + 'targetUrl' => [ + 'description' => '用户自行写入的跳转链接，代码平台仅提供跳转的UI，一般可设置为三方系统的链接', + 'type' => 'string', + 'example' => 'xxx', + ], + 'description' => [ + 'description' => '提交状态的简要描述，且不能超过3000个字符', + 'type' => 'string', + 'example' => '提交状态描述内容', + ], + 'creator' => [ + 'description' => '提交状态的写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '阿里云账号ID，若type=Bot时，则为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204485087002425236', + ], + 'login' => [ + 'description' => '若type=User，则为用户名；若type=Bot，则为应用名', + 'type' => 'string', + 'example' => 'codeup', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'type' => [ + 'description' => '写入人类型'."\n" + .'- User：普通用户类型'."\n" + .'- Bot：应用类型', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"020F71F3-F063-5B8B-8978-2B01833216BB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"sha\\": \\"c0ca103441b9fa7f369be8d24a6f20db44dfddf7\\",\\n \\"context\\": \\"default\\",\\n \\"state\\": \\"success\\",\\n \\"targetUrl\\": \\"xxx\\",\\n \\"description\\": \\"提交状态描述内容\\",\\n \\"creator\\": {\\n \\"aliyunPk\\": 204485087002425250,\\n \\"login\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"type\\": \\"User\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '添加提交状态记录', + 'description' => '根据Commit SHA和Context作为组合条件，限制单库的提交状态记录不超过1000条，否则会报错。', + ], + 'ListCommitStatuses' => [ + 'summary' => '查询提交状态列表，支持分页。', + 'path' => '/api/v4/projects/repository/commit_statuses/list_commit_statuses', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'sha', + 'in' => 'query', + 'schema' => [ + 'description' => '仅支持提交ID，即Commit SHA', + 'type' => 'string', + 'required' => true, + 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', + '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' => 'ID（无业务实际意义', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19285', + ], + 'sha' => [ + 'description' => '仅支持提交ID，即Commit SHA', + 'type' => 'string', + 'example' => '61cc69557962d29f737a91730b3e86f497f083a3', + ], + 'context' => [ + 'description' => '用于区分不同系统写入的字符串标识，会以标题的作用在相应的页面UI处进行展示，默认为default，长度不超过50，且英文大小写不敏感', + 'type' => 'string', + 'example' => 'test-commit-status-context', + ], + 'state' => [ + 'description' => '写入状态'."\n" + ."\n" + .'- error：异常'."\n" + .'- failure：失败'."\n" + .'- pending：运行中'."\n" + .'- success：成功', + 'type' => 'string', + 'example' => 'success', + ], + 'targetUrl' => [ + 'description' => '用户自行写入的跳转链接，代码平台仅提供跳转的UI，一般可设置为三方系统的链接', + 'type' => 'string', + 'example' => 'xxx', + ], + 'description' => [ + 'description' => '提交状态的简要描述，且不能超过3000个字符', + 'type' => 'string', + 'example' => '描述信息的具体内容'."\n", + ], + 'creator' => [ + 'description' => '提交状态的写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'aliyunPk' => [ + 'description' => '阿里云账号ID，若type=Bot时，则为空', + 'type' => 'string', + 'example' => '235671547828975455', + ], + 'login' => [ + 'description' => '若type=User，则为用户名；若type=Bot，则为应用名', + 'type' => 'string', + 'example' => 'codeup', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'type' => [ + 'description' => '写入人类型'."\n" + ."\n" + .'- User：普通用户类型'."\n" + .'- Bot：应用类型', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 28,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"sha\\": \\"61cc69557962d29f737a91730b3e86f497f083a3\\",\\n \\"context\\": \\"test-commit-status-context\\",\\n \\"state\\": \\"success\\",\\n \\"targetUrl\\": \\"xxx\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"creator\\": {\\n \\"aliyunPk\\": \\"235671547828975455\\",\\n \\"login\\": \\"codeup\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"type\\": \\"User\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询提交状态列表', + ], + 'CreateCheckRun' => [ + 'summary' => '添加检查运行记录，仅创建。', + 'path' => '/api/v4/projects/check_runs/create_check_run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '检查运行的名称'."\n" + ."\n\n" + .'> 在一定环境下（指定代码库、提交ID、写入人），名称具有唯一性；长度限制在50以内', + 'type' => 'string', + 'required' => true, + 'example' => 'my-check-ci', + ], + 'headSha' => [ + 'description' => '提交ID'."\n" + ."\n\n" + .'> Commit SHA，但需要确保该commit是某个合并请求的合并源', + 'type' => 'string', + 'required' => true, + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '状态'."\n" + ."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功状态'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'startedAt' => [ + 'description' => '检查运行的开始时间'."\n" + ."\n\n" + ."\n" + .'> ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z', + ], + 'completedAt' => [ + 'description' => '检查运行的完结时间'."\n" + ."\n\n" + .'> 说明 ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z', + ], + 'externalId' => [ + 'description' => '外部系统的ID'."\n" + .'> 外部系统，指用户的检测系统；该字段由用户自行决定写入何种ID，平台仅使用字符串类型进行存储', + 'type' => 'string', + 'required' => false, + 'example' => '42', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'output' => [ + 'description' => '各类展示信息', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => 'UI模块的标题（非name）', + 'type' => 'string', + 'required' => true, + 'example' => 'Mighty Readme report', + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'required' => true, + 'example' => '摘要信息内容', + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'required' => false, + 'example' => '详情信息内容', + ], + 'images' => [ + 'description' => '图片信息'."\n" + ."\n\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + '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' => '检查注释列表'."\n" + ."\n\n" + .'> 对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过API将信息通过annotation写入到check run中。', + 'type' => 'array', + 'items' => [ + 'description' => '检查注释信息', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => true, + 'example' => 'demo/test.txt', + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'required' => true, + 'example' => 'notice', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'required' => true, + 'example' => '回写检查注释的简要描述信息', + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'required' => false, + 'example' => '检查注释的标题', + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'required' => false, + 'example' => '详情信息内容', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'updatedAt' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00', + ], + 'startedAt' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z', + ], + 'completedAt' => [ + 'description' => '完结时间', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z', + ], + 'externalId' => [ + 'description' => '外部系统ID', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '状态'."\n" + ."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '检查套件', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查套件ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '用户阿里云账号ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '写入人类型'."\n" + ."\n" + .'- User：用户类型', + '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' => 'UI模块的标题（非name）', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '摘要信息内容'."\n", + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '详情信息内容'."\n", + ], + 'images' => [ + 'description' => '图片信息列表'."\n" + ."\n\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + 'type' => 'string', + 'example' => 'test-image-alt', + ], + 'imageUrl' => [ + 'description' => '图片地址，须确保能够有效访问，否则页面无法展示', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '图片信息的简要描述', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '检查注释列表'."\n" + ."\n\n" + .'> 对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过API将信息通过annotation写入到check run中。', + 'type' => 'array', + 'items' => [ + 'description' => '检查注释信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查注释ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'demo/test.txt', + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'example' => 'notice', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'example' => '回写检查注释的简要描述信息'."\n", + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'example' => '检查注释的标题', + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'example' => '详情信息', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"slug\\": \\"test-codeup\\",\\n \\"logoUrl\\": \\"xxx\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\\\n\\",\\n \\"text\\": \\"详情信息内容\\\\n\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 2,\\n \\"path\\": \\"demo/test.txt\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 5,\\n \\"annotationLevel\\": \\"notice\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\",\\n \\"rawDetails\\": \\"详情信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '添加检查运行记录', + ], + 'UpdateCheckRun' => [ + 'summary' => '更新check run记录信息，须当前身份与check run的写入人身份一致，才能进行更新。', + 'path' => '/api/v4/projects/check_runs/update_check_run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'checkRunId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查运行ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '检查运行的名称', + 'type' => 'string', + 'required' => false, + 'example' => 'my-check-ci'."\n", + ], + 'startedAt' => [ + 'description' => '检查运行的开始时间'."\n" + ."\n\n" + ."\n" + .'> ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '检查运行的完结时间'."\n" + ."\n\n" + .'> 说明 ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ，如 2023-03-15T08:00:00Z', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '外部系统的ID'."\n" + .'> 外部系统，指用户的检测系统；该字段由用户自行决定写入何种ID，平台仅使用字符串类型进行存储', + 'type' => 'string', + 'required' => false, + 'example' => '42', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + 'status' => [ + 'description' => '状态'."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功状态'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'output' => [ + 'description' => '页面展示信息', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => 'UI模块的标题（非name）', + 'type' => 'string', + 'required' => false, + 'example' => 'Mighty Readme report', + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'required' => true, + 'example' => '摘要信息内容'."\n", + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'required' => false, + 'example' => '详情信息内容'."\n", + ], + 'images' => [ + 'description' => '图片信息列表'."\n" + ."\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + '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' => '检查注释列表'."\n" + ."\n\n" + .'> - 对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过API将信息通过annotation写入到check run中'."\n" + .'> - 在更新操作中，annotations信息只会新增，所以在使用时，尽量不要重复写入', + 'type' => 'array', + 'items' => [ + 'description' => '检查注释', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => true, + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'required' => true, + 'example' => 'failure', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'required' => true, + 'example' => '回写检查注释的简要描述信息'."\n", + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'required' => false, + 'example' => '检查注释的标题', + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'required' => false, + 'example' => '详情信息内容'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'updatedAt' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'startedAt' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'completedAt' => [ + 'description' => '完结时间', + 'type' => 'string', + 'example' => '2023-03-15T08:00:00Z'."\n", + ], + 'externalId' => [ + 'description' => '外部系统ID', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be'."\n", + ], + 'status' => [ + 'description' => '状态'."\n" + ."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '检查套件', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查套件ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '用户阿里云账号ID', + 'type' => 'string', + 'example' => 'xxx'."\n", + ], + 'type' => [ + 'description' => '写入人类型'."\n" + ."\n" + .'- User：用户类型', + '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' => 'UI模块的标题（非name）', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '摘要信息内容'."\n", + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '详情信息内容', + ], + 'images' => [ + 'description' => '图片信息'."\n" + ."\n\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + 'type' => 'string', + 'example' => 'test-image-alt'."\n", + ], + 'imageUrl' => [ + 'description' => '图片地址，须确保能够有效访问，否则页面无法展示', + 'type' => 'string', + 'example' => 'xxx', + ], + 'caption' => [ + 'description' => '图片信息的简要描述', + 'type' => 'string', + 'example' => 'test'."\n", + ], + ], + ], + ], + ], + ], + 'annotations' => [ + 'description' => '检查注释列表'."\n" + ."\n\n" + .'> 对于某些三方系统，可能会获得代码质量检测结果，若希望进行展示，可通过API将信息通过annotation写入到check run中。', + 'type' => 'array', + 'items' => [ + 'description' => '检查注释', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查注释ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'example' => '回写检查注释的简要描述信息'."\n", + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'example' => '检查注释的标题'."\n", + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'example' => '详情信息'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '更新检查运行', + ], + 'GetCheckRun' => [ + 'summary' => '查询单个check run记录。', + 'path' => '/api/v4/projects/check_runs/get_check_run', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'checkRunId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查运行ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '外部系统ID', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '状态'."\n" + ."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功状态'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '检查套件', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查套件ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '用户阿里云账号ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '写入人类型'."\n" + ."\n" + .'- User：用户类型', + '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' => 'UI模块的标题（非name）', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '摘要信息内容'."\n", + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '详情信息内容'."\n", + ], + 'images' => [ + 'description' => '图片信息列表'."\n" + ."\n\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + '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' => '检查注释ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'example' => '回写检查注释的简要描述信息'."\n", + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'example' => '检查注释的标题'."\n", + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'example' => '详情信息', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 5240,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"startedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"completedAt\\": \\"2023-03-15T08:00:00Z\\\\n\\",\\n \\"externalId\\": \\"42\\",\\n \\"name\\": \\"my-check-ci\\\\n\\",\\n \\"headSha\\": \\"40f4ccfe019cdd4a62d4acb0c57130106fc7e1be\\",\\n \\"status\\": \\"completed\\",\\n \\"conclusion\\": \\"success\\",\\n \\"detailsUrl\\": \\"xxx\\",\\n \\"checkSuite\\": {\\n \\"id\\": 1\\n },\\n \\"writer\\": {\\n \\"id\\": \\"xxx\\",\\n \\"type\\": \\"User\\",\\n \\"name\\": \\"test-codeup\\\\n\\",\\n \\"slug\\": \\"test-codeup\\",\\n \\"logoUrl\\": \\"xxx\\"\\n },\\n \\"output\\": {\\n \\"title\\": \\"Mighty Readme report\\\\n\\",\\n \\"summary\\": \\"摘要信息内容\\\\n\\",\\n \\"text\\": \\"详情信息内容\\\\n\\",\\n \\"images\\": [\\n {\\n \\"alt\\": \\"test-image-alt\\\\n\\",\\n \\"imageUrl\\": \\"xxx\\",\\n \\"caption\\": \\"test\\"\\n }\\n ]\\n },\\n \\"annotations\\": [\\n {\\n \\"id\\": 1,\\n \\"path\\": \\"demo/test.txt\\\\n\\",\\n \\"startLine\\": 1,\\n \\"endLine\\": 2,\\n \\"startColumn\\": 3,\\n \\"endColumn\\": 4,\\n \\"annotationLevel\\": \\"warning\\",\\n \\"message\\": \\"回写检查注释的简要描述信息\\\\n\\",\\n \\"title\\": \\"检查注释的标题\\\\n\\",\\n \\"rawDetails\\": \\"详情信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询检查运行', + ], + 'ListCheckRuns' => [ + 'summary' => '查询check run列表，支持分页功能。', + 'path' => '/api/v4/projects/check_runs/list_check_runs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'ref', + 'in' => 'query', + 'schema' => [ + 'description' => '分支名称、标签名称或者提交ID', + 'type' => 'string', + 'required' => true, + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '外部系统ID', + 'type' => 'string', + 'example' => '42', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'my-check-ci'."\n", + ], + 'headSha' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => '40f4ccfe019cdd4a62d4acb0c57130106fc7e1be', + ], + 'status' => [ + 'description' => '状态'."\n" + ."\n" + .'- queued：队列中'."\n" + .'- in_progress：运行中'."\n" + .'- completed：已完结', + 'type' => 'string', + 'example' => 'completed', + ], + 'conclusion' => [ + 'description' => '结论'."\n" + ."\n" + .'- cancelled：已取消'."\n" + .'- failure：失败'."\n" + .'- neutral：中立状态，算作成功状态'."\n" + .'- success：成功'."\n" + .'- skipped：跳过，算作成功状态'."\n" + .'- timed_out：超时', + 'type' => 'string', + 'example' => 'success', + ], + 'detailsUrl' => [ + 'description' => '三方交互系统的详情地址，由用户自行决定，平台仅提供跳转能力', + 'type' => 'string', + 'example' => 'xxx', + ], + 'checkSuite' => [ + 'description' => '检查套件', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '检查套件ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'writer' => [ + 'description' => '写入人简要信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '用户阿里云账号ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '写入人类型'."\n" + ."\n" + .'- User：用户类型', + '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' => 'UI模块的标题（非name）', + 'type' => 'string', + 'example' => 'Mighty Readme report'."\n", + ], + 'summary' => [ + 'description' => '检查运行的摘要信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '摘要信息内容', + ], + 'text' => [ + 'description' => '详情信息'."\n" + ."\n\n" + .'> 支持markdown格式；最大字符长度为64KB，即65535个字符', + 'type' => 'string', + 'example' => '详情信息内容', + ], + 'images' => [ + 'description' => '图片信息列表'."\n" + ."\n\n" + .'> check run支持在output的展示模块中，展示图片信息', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息', + 'type' => 'object', + 'properties' => [ + 'alt' => [ + 'description' => 'alt文本信息', + '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' => '检查注释ID，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11806', + ], + 'path' => [ + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'demo/test.txt'."\n", + ], + 'startLine' => [ + 'description' => '起始行'."\n" + ."\n\n" + .'> 从1开始；需要用户自行确保文件行数的有效性，否则无法展示', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'endLine' => [ + 'description' => '结束行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'startColumn' => [ + 'description' => '起始列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'endColumn' => [ + 'description' => '结束列'."\n" + ."\n\n" + .'> 当且仅当startLine=endLine时，该字段值有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'annotationLevel' => [ + 'description' => '检查注释的等级'."\n" + ."\n" + .'- notice：轻微'."\n" + .'- warning：警告'."\n" + .'- failure：严重', + 'type' => 'string', + 'example' => 'warning', + ], + 'message' => [ + 'description' => '简要描述信息', + 'type' => 'string', + 'example' => '回写检查注释的简要描述信息'."\n", + ], + 'title' => [ + 'description' => '检查注释的标题', + 'type' => 'string', + 'example' => '检查注释的标题', + ], + 'rawDetails' => [ + 'description' => '详情信息，限制64KB以内的大小', + 'type' => 'string', + 'example' => '详情信息'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询检查运行列表', + ], + 'CreateTag' => [ + 'summary' => '创建代码库标签（Tag）。', + 'path' => '/repository/{repositoryId}/tags/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2080972', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求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' => '描述信息', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '标签ID', + 'type' => 'string', + 'example' => '0e3b6aa5eab2b086b59fde74766b28d4e5faab0d', + ], + 'name' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => 'v1.0', + ], + 'message' => [ + 'description' => '标签的描述信息', + 'type' => 'string', + 'example' => '描述内容', + ], + 'commit' => [ + 'description' => '标签指向的提交信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'e0297d8f', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题'."\n", + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '具体的提交内容'."\n", + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '阿里云云效committer', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'parentIds' => [ + 'description' => '父提交ID', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"0e3b6aa5eab2b086b59fde74766b28d4e5faab0d\\",\\n \\"name\\": \\"v1.0\\",\\n \\"message\\": \\"描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\\\n\\",\\n \\"message\\": \\"具体的提交内容\\\\n\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建标签Tag', + ], + 'DeleteTag' => [ + 'summary' => '删除代码库标签（Tag）。', + 'path' => '/repository/{repositoryId}/tags/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '609633ffd40eb063bac8165a', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2289464', + ], + ], + [ + 'name' => 'tagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名', + 'type' => 'string', + 'required' => true, + 'example' => 'v1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '60945D4F-CF6D-5CFF-89ED-1D1F6657032C', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'tagName' => [ + 'description' => '删除的标签名', + 'type' => 'string', + 'example' => 'v1.0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"60945D4F-CF6D-5CFF-89ED-1D1F6657032C\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"tagName\\": \\"v1.0\\"\\n }\\n}","type":"json"}]', + 'title' => '删除标签Tag', + ], + 'GetRepositoryTag' => [ + 'summary' => '查询代码库的单个标签信息。', + 'path' => '/repository/{repositoryId}/tag/info', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'tagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + 'type' => 'string', + 'required' => true, + 'example' => 'tag v1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '标签ID', + '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' => '提交ID', + 'type' => 'string', + 'example' => 'e0297d8fb0393c833a8531e7cc8832739e3cba6d', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + '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' => '父提交ID', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 08:00:00', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '阿里云云效Committer', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'signature' => [ + 'description' => '签名信息', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => 'gpg签名的key id', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CE7353E3-F989-56A9-B97C-897ABBDB9A01\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": \\"9a494e7b88ca35cde00579af2df4ab46136c022e\\",\\n \\"name\\": \\"tag v1.0\\\\n\\",\\n \\"message\\": \\"具体的描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"e0297d8fb0393c833a8531e7cc8832739e3cba6d\\",\\n \\"shortId\\": \\"e0297d8f\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"具体的提交内容\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ],\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 08:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询单个标签信息', + ], + 'ListRepositoryTags' => [ + 'summary' => '查询代码库的标签（Tag）列表。', + 'path' => '/repository/{repositoryId}/tag/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '611b75680fc7bf0dbe1dce55', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为updated_desc'."\n" + .'- updated_asc：更新时间，升序'."\n" + .'- updated_desc：更新时间，降序'."\n" + .'- name_asc：标签名称，升序'."\n" + .'- name_desc：标签名称，降序', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_desc', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字（匹配标签名称）', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '标签ID', + 'type' => 'string', + 'example' => '9a494e7b88ca35cde00579af2df4ab46136c022e', + ], + 'name' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => 'tag v1.0', + ], + 'message' => [ + 'description' => '标签的描述信息', + 'type' => 'string', + 'example' => '具体的描述内容', + ], + 'commit' => [ + 'description' => '标签指向的提交信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'de02b625ba8488f92eb204bcb3773a40c1b4ddac', + ], + 'shortId' => [ + 'description' => '简短的提交ID', + 'type' => 'string', + 'example' => 'de02b625', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'message' => [ + 'description' => '提交内容', + 'type' => 'string', + 'example' => '修改main.txt文件', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'authorName' => [ + 'description' => '作者姓名', + 'type' => 'string', + 'example' => '阿里云云效', + ], + 'authorEmail' => [ + 'description' => '作者邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'authoredDate' => [ + 'description' => '作者提交时间', + 'type' => 'string', + 'example' => '2022-03-18 10:00:00', + ], + 'committerName' => [ + 'description' => '提交人的姓名', + 'type' => 'string', + 'example' => '阿里云云效Committer', + ], + 'committerEmail' => [ + 'description' => '提交人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'committedDate' => [ + 'description' => '提交人的提交时间', + 'type' => 'string', + 'example' => '2022-03-18 09:00:00', + ], + 'parentIds' => [ + 'description' => '父提交ID', + 'type' => 'array', + 'items' => [ + 'description' => '父提交ID', + 'type' => 'string', + 'example' => '34d2c47c7ce46a5c4639c5ffe208a66dda975a05', + ], + ], + 'signature' => [ + 'description' => '签名信息', + 'type' => 'object', + 'properties' => [ + 'gpgKeyId' => [ + 'description' => 'gpg签名的key id', + 'type' => 'string', + 'example' => '""', + ], + 'verificationStatus' => [ + 'description' => 'gpg校验状态'."\n" + .'- unverified：未校验'."\n" + .'- verified：gpg公钥验证通过且邮箱一致'."\n" + .'- same_user_different_email：gpg公钥验签通过，提交者邮箱属于当前用户，但与证书邮箱不一致'."\n" + .'- other_user：gpg公钥验签通过，但提交者邮箱不属于key的用户'."\n" + .'- unverified_key：key对应的邮箱，不在该用户的邮箱列表中'."\n" + .'- unknown_key：gpg key不存在', + 'type' => 'string', + 'example' => 'verified', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"id\\": \\"9a494e7b88ca35cde00579af2df4ab46136c022e\\",\\n \\"name\\": \\"tag v1.0\\",\\n \\"message\\": \\"具体的描述内容\\",\\n \\"commit\\": {\\n \\"id\\": \\"de02b625ba8488f92eb204bcb3773a40c1b4ddac\\",\\n \\"shortId\\": \\"de02b625\\",\\n \\"title\\": \\"提交标题\\",\\n \\"message\\": \\"修改main.txt文件\\",\\n \\"createdAt\\": \\"2022-03-18 10:00:00\\",\\n \\"authorName\\": \\"阿里云云效\\",\\n \\"authorEmail\\": \\"[email protected]\\",\\n \\"authoredDate\\": \\"2022-03-18 10:00:00\\",\\n \\"committerName\\": \\"阿里云云效Committer\\",\\n \\"committerEmail\\": \\"[email protected]\\",\\n \\"committedDate\\": \\"2022-03-18 09:00:00\\",\\n \\"parentIds\\": [\\n \\"34d2c47c7ce46a5c4639c5ffe208a66dda975a05\\"\\n ],\\n \\"signature\\": {\\n \\"gpgKeyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"verificationStatus\\": \\"verified\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询标签列表', + ], + 'CreateProjectLabel' => [ + 'summary' => '创建代码库类标。', + 'path' => '/api/v4/projects/labels', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'required' => true, + 'example' => '新特性', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'required' => true, + 'example' => '#006AD4', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'required' => false, + 'example' => '新的特性或需求', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，每次请求都是唯一值，便于后续排查问题', + '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' => '类标ID，唯一标识', + 'type' => 'string', + 'example' => 'b5b5738b94954bc6aa5a293316ed1d24', + ], + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'example' => '新特性', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'example' => '#006AD4', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'example' => '新的特性或需求'."\n", + ], + ], + ], + ], + ], + ], + ], + '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' => '创建类标', + ], + 'UpdateProjectLabel' => [ + 'summary' => '更新代码库类标信息。', + 'path' => '/api/v4/projects/labels/{labelId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'labelId', + 'in' => 'path', + 'schema' => [ + 'description' => '类标ID，唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '54e2699e538b4ba985177d6eb4d16cee', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'required' => false, + 'example' => '缺陷', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'required' => false, + 'example' => '#EF433B', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'required' => false, + 'example' => '需要进行修复的缺陷', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '类标ID，唯一标识', + 'type' => 'string', + 'example' => '8d84d73cf315473683400760f02dbfc1', + ], + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'example' => '缺陷', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'example' => '#EF433B', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'example' => '需要进行修复的缺陷', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": \\"8d84d73cf315473683400760f02dbfc1\\",\\n \\"name\\": \\"缺陷\\",\\n \\"color\\": \\"#EF433B\\",\\n \\"description\\": \\"需要进行修复的缺陷\\"\\n }\\n}","type":"json"}]', + 'title' => '更新类标', + ], + 'DeleteProjectLabel' => [ + 'summary' => '删除代码库类标。', + 'path' => '/api/v4/projects/labels/{labelId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'labelId', + 'in' => 'path', + 'schema' => [ + 'description' => '类标ID，唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '54e2699e538b4ba985177d6eb4d16cee', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '删除类标', + ], + 'ListProjectLabels' => [ + 'summary' => '查询代码库类标列表，支持分页、字段排序以及关键字搜索。', + 'path' => '/api/v4/projects/labels', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:'."\n" + .'//devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字，匹配类标名称', + 'type' => 'string', + 'required' => false, + 'example' => 'TEST', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，可选值：'."\n" + ."\n" + .'- label_name：默认，按类标名称排序', + 'type' => 'string', + 'required' => false, + 'example' => 'label_name', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'withCounts', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回关联的合并请求数量，默认为false，不返回', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '类标列表', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '类标ID，唯一标识', + 'type' => 'string', + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'example' => '优化', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'example' => '#A16AD7', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'example' => '已有内容的优化或重构', + ], + 'openMergeRequestsCount' => [ + 'description' => '关联的评审中的合并请求数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"id\\": \\"f2bf0e0b4ce34a348b2d971c69a1d11f\\",\\n \\"name\\": \\"优化\\",\\n \\"color\\": \\"#A16AD7\\",\\n \\"description\\": \\"已有内容的优化或重构\\",\\n \\"openMergeRequestsCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询类标列表', + ], + 'ListMergeRequestLabels' => [ + 'summary' => '查询指定合并请求下关联的类标列表。', + 'path' => '/api/v4/projects/merge_requests/labels', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo'."\n", + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4D6AF7CC-B43B-5454-86AB-023D25E44868', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回详情结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '类标ID', + 'type' => 'string', + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'name' => [ + 'description' => '类标名称', + 'type' => 'string', + 'example' => '优化', + ], + 'description' => [ + 'description' => '类标描述', + 'type' => 'string', + 'example' => '已有内容的优化或重构', + ], + 'color' => [ + 'description' => '类标颜色', + 'type' => 'string', + 'example' => '#A16AD7', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4D6AF7CC-B43B-5454-86AB-023D25E44868\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"f2bf0e0b4ce34a348b2d971c69a1d11f\\",\\n \\"name\\": \\"优化\\",\\n \\"description\\": \\"已有内容的优化或重构\\",\\n \\"color\\": \\"#A16AD7\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询合并请求类标列表', + ], + 'LinkMergeRequestLabel' => [ + 'summary' => '将类标（Label）关联到合并请求中。', + 'path' => '/api/v4/projects/merge_requests/link_labels', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码库ID或者全路径', + 'type' => 'string', + 'required' => true, + 'example' => '2835387 或 codeup/codeup-demo', + ], + ], + [ + 'name' => 'localId', + 'in' => 'query', + 'schema' => [ + 'description' => '合并请求局部ID，表示代码库下的第几个合并请求', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'labelIds' => [ + 'description' => '合并请求类标ID列表'."\n" + ."\n\n" + .'><notice>此处是覆盖式更新，若想要保留之前关联的类标，那么需要一起传入，否则之前关联的类标会被覆盖></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '类标ID', + 'type' => 'string', + 'required' => false, + 'example' => 'f2bf0e0b4ce34a348b2d971c69a1d11f', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码'."\n" + ."\n", + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '关联是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '关联合并请求', + ], + 'AddWebhook' => [ + 'summary' => '创建代码库Webhook。', + 'path' => '/repository/{repositoryId}/webhooks/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2835387', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'url' => [ + 'title' => 'hook url', + 'description' => 'Webhook链接URL', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxxx', + ], + 'pushEvents' => [ + 'title' => '分支推送事件', + 'description' => '是否订阅分支推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'mergeRequestsEvents' => [ + 'title' => '合并请求事件', + 'description' => '是否订阅合并请求事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'tagPushEvents' => [ + 'title' => '标签推送事件', + 'description' => '是否订阅标签推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'noteEvents' => [ + 'title' => '评论事件', + 'description' => '是否订阅评论事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'enableSslVerification' => [ + 'title' => '使用ssl认证', + 'description' => '使用SSL认证'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'description' => [ + 'title' => 'webhook描述', + 'description' => 'webhook描述', + 'type' => 'string', + 'required' => false, + 'example' => '线下测试', + ], + 'secretToken' => [ + 'title' => '', + 'description' => '用于验证身份的Token，用户自定义', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '“”', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_NOT_FOUND_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '结果。', + 'type' => 'object', + 'properties' => [ + 'pushEvents' => [ + 'description' => '是否订阅分支推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'repositoryId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2835387', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'url' => [ + 'description' => 'webhook链接URL', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'tagPushEvents' => [ + 'description' => '是否订阅标签推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'lastTestResult' => [ + 'description' => '最后执行结果'."\n" + .'可选值：ok / error / ""（空字符串）', + 'type' => 'string', + 'example' => 'ok', + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => '线下测试', + ], + 'mergeRequestsEvents' => [ + 'description' => '是否订阅合并请求事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'secretToken' => [ + 'description' => '用于验证身份的token，用户自定义', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'noteEvents' => [ + 'description' => '是否订阅评论事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'id' => [ + 'description' => 'webhook唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'enableSslVerification' => [ + 'description' => '是否使用SSL认证'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"“”\\",\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorCode\\": \\"SYSTEM_NOT_FOUND_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"pushEvents\\": true,\\n \\"repositoryId\\": 2835387,\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"url\\": \\"https://xxxxx\\",\\n \\"tagPushEvents\\": true,\\n \\"lastTestResult\\": \\"ok\\",\\n \\"description\\": \\"线下测试\\",\\n \\"mergeRequestsEvents\\": true,\\n \\"secretToken\\": \\"xxxx\\",\\n \\"noteEvents\\": false,\\n \\"id\\": 30815,\\n \\"enableSslVerification\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddWebhookResponse>\\n <errorMessage>“”</errorMessage>\\n <requestId>6177543A-8D54-5736-A93B-E0195A1512CB</requestId>\\n <errorCode>SYSTEM_NOT_FOUND_ERROR</errorCode>\\n <success>true</success>\\n <result>\\n <pushEvents>true</pushEvents>\\n <repositoryId>2835387</repositoryId>\\n <createdAt>2022-03-12 12:00:00</createdAt>\\n <url>https://xxxxx</url>\\n <tagPushEvents>true</tagPushEvents>\\n <lastTestResult>ok</lastTestResult>\\n <description>线下测试</description>\\n <mergeRequestsEvents>true</mergeRequestsEvents>\\n <secretToken>xxxx</secretToken>\\n <noteEvents>false</noteEvents>\\n <id>30815</id>\\n <enableSslVerification>false</enableSslVerification>\\n </result>\\n</AddWebhookResponse>","errorExample":""}]', + 'title' => '创建代码库Webhook', + ], + 'DeleteRepositoryWebhook' => [ + 'summary' => '删除代码库下的Webhook。', + 'path' => '/repository/{repositoryId}/hooks/{hookId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2369234', + ], + ], + [ + 'name' => 'hookId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Webhook的ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '524836', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'webhook唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '524836', + ], + 'url' => [ + 'description' => 'webhook链接URL', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2369234', + ], + 'pushEvents' => [ + 'description' => '是否订阅分支推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'issuesEvents' => [ + 'description' => '是否订阅Issues事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'mergeRequestsEvents' => [ + 'description' => '是否订阅合并请求事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'tagPushEvents' => [ + 'description' => '是否订阅标签推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'buildEvents' => [ + 'description' => '是否订阅build事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'noteEvents' => [ + 'description' => '是否订阅评论事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableSslVerification' => [ + 'description' => '是否使用SSL认证'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'lastTestResult' => [ + 'description' => '最后执行结果，可选值：ok / error / ""（空字符串）', + 'type' => 'string', + 'example' => '""', + ], + 'description' => [ + 'description' => 'Webhook描述信息', + 'type' => 'string', + 'example' => 'Webhook描述内容', + ], + 'secretToken' => [ + 'description' => '用于验证身份的token，用户自定义', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'type' => [ + 'description' => 'Webhook类型'."\n" + .'可选值：'."\n" + .'ProjectHook（代码库webhook）；'."\n" + .'OrganizationHook（企业webhook）', + 'type' => 'string', + 'example' => 'ProjectHook', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 524836,\\n \\"url\\": \\"https://xxxxx\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"projectId\\": 2369234,\\n \\"pushEvents\\": true,\\n \\"issuesEvents\\": false,\\n \\"mergeRequestsEvents\\": true,\\n \\"tagPushEvents\\": true,\\n \\"buildEvents\\": false,\\n \\"noteEvents\\": true,\\n \\"enableSslVerification\\": false,\\n \\"lastTestResult\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"Webhook描述内容\\",\\n \\"secretToken\\": \\"xxxx\\",\\n \\"type\\": \\"ProjectHook\\"\\n }\\n}","type":"json"}]', + 'title' => '删除代码库Webhook', + ], + 'ListRepositoryWebhook' => [ + 'summary' => '批量查询在代码仓库上配置的webhook记录，支持分页功能。', + 'path' => '/repository/{repositoryId}/webhooks/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'accessToken', + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => '0cf2c8458ac44d9481aab2dd6ec10596v3'."\n", + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业Id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5fbe3118672533690be72b12', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码仓库Id', + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2825387', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码'."\n" + .'默认值为1，从第1页开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数据量', + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果对象', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '“”', + ], + 'requestId' => [ + 'description' => '请求ID', + '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' => 'SYSTEM_NOT_FOUND_ERROR', + ], + 'result' => [ + 'description' => 'dataSet列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回详情结果'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'pushEvents' => [ + 'description' => '是否为代码推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'projectId' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2825387', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'url' => [ + 'description' => 'webhook链接', + 'type' => 'string', + 'example' => 'https://xxxx', + ], + 'tagPushEvents' => [ + 'description' => '是否为标签推送事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'lastTestResult' => [ + 'description' => '最后执行结果'."\n" + .'可选值：ok / error / ""（空字符串）', + 'type' => 'string', + 'example' => 'ok', + ], + 'mergeRequestsEvents' => [ + 'description' => '是否为代码合并事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '线下测试', + ], + 'noteEvents' => [ + 'description' => '是否为评论事件'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'secretToken' => [ + 'description' => '密钥，用户自定义用于区分hook', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'id' => [ + 'description' => 'webhook唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16776', + ], + 'enableSslVerification' => [ + 'description' => '是否使用SSL认证'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"“”\\",\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"total\\": 100,\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_NOT_FOUND_ERROR\\",\\n \\"result\\": [\\n {\\n \\"pushEvents\\": false,\\n \\"projectId\\": 2825387,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"url\\": \\"https://xxxx\\",\\n \\"tagPushEvents\\": false,\\n \\"lastTestResult\\": \\"ok\\",\\n \\"mergeRequestsEvents\\": true,\\n \\"description\\": \\"线下测试\\",\\n \\"noteEvents\\": false,\\n \\"secretToken\\": \\"xxxx\\",\\n \\"id\\": 16776,\\n \\"enableSslVerification\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRepositoryWebhookResponse>\\n <errorMessage>“”</errorMessage>\\n <requestId>HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <total>100</total>\\n <success>true</success>\\n <errorCode>SYSTEM_NOT_FOUND_ERROR</errorCode>\\n <result>\\n <pushEvents>false</pushEvents>\\n <projectId>2825387</projectId>\\n <createdAt>2022-03-18 14:24:54</createdAt>\\n <url>https://xxxx</url>\\n <tagPushEvents>false</tagPushEvents>\\n <lastTestResult>OK</lastTestResult>\\n <mergeRequestsEvents>true</mergeRequestsEvents>\\n <description>线下测试</description>\\n <noteEvents>false</noteEvents>\\n <secretToken>xxxx</secretToken>\\n <id>16776</id>\\n <enableSslVerification>false</enableSslVerification>\\n </result>\\n</ListRepositoryWebhookResponse>","errorExample":""}]', + 'title' => '查询代码仓库的webhook列表', + ], + 'CreateRepositoryGroup' => [ + 'summary' => '创建代码组。', + 'path' => '/repository/groups/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + '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' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '26842', + ], + 'description' => [ + 'description' => '代码组的描述信息', + 'type' => 'string', + 'required' => false, + 'example' => '描述信息的具体内容', + ], + 'avatarUrl' => [ + 'description' => '代码组的头像地址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码组的主键ID', + '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' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'pathWithNamespace' => [ + 'description' => '路径（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org/test-create-group', + ], + 'nameWithNamespace' => [ + 'description' => '名称（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org / test-create-group （斜杠两侧有空格）', + ], + 'type' => [ + 'description' => '类型，默认为Group', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '拥有者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 18685,\\n \\"name\\": \\"test-create-group\\",\\n \\"path\\": \\"test-create-group\\",\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-create-group\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-create-group （斜杠两侧有空格）\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10,\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230\\n }\\n}","type":"json"}]', + 'title' => '创建代码组', + ], + 'DeleteRepositoryGroup' => [ + 'summary' => '删除某个指定的代码库。', + 'path' => '/repository/groups/{groupId}/remove', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '624666bd54d036291ae13a36', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22901', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'description' => '删除代码组的原因（必填）', + 'type' => 'string', + 'required' => true, + 'example' => '代码组废弃且不再使用', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '30F2DA15-2877-5FC9-BC71-F7F394717907', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"30F2DA15-2877-5FC9-BC71-F7F394717907\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '删除代码组', + ], + 'UpdateGroup' => [ + 'summary' => '更新单个代码组信息，以pathWithNamespace作为唯一标识。', + 'path' => '/groups/modify', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61dxxxxxxx975a93f9129d2513', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + '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' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'description' => [ + 'description' => '代码组描述', + 'type' => 'string', + 'required' => false, + 'example' => '描述信息的具体内容', + ], + 'avatarUrl' => [ + 'description' => '代码组的头像地址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '返回详情结果'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码组主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'pathWithNamespace' => [ + 'description' => '代码组完整路径（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org/test-codeup', + ], + 'nameWithNamespace' => [ + 'description' => '代码组完整名称（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org / codeup（斜杠两侧有空格）', + ], + 'name' => [ + 'description' => '代码组名称', + 'type' => 'string', + 'example' => 'codeup', + ], + 'path' => [ + 'description' => '代码组路径', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'ownerId' => [ + 'description' => '拥有者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'parentId' => [ + 'description' => '父路径ID', + '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' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'type' => [ + 'description' => '类型，默认为Group', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"InvalidParam.NoPermission\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-codeup\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / codeup（斜杠两侧有空格）\\",\\n \\"name\\": \\"codeup\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"ownerId\\": 19230,\\n \\"parentId\\": 26842,\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10\\n }\\n}","type":"json"}]', + 'title' => '更新代码组信息', + ], + 'GetGroupDetail' => [ + 'summary' => '查询指定的某个代码组信息。', + 'path' => '/repository/groups/get_detail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '6218766746d4d2ca636d0497', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '代码组主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '36612', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '代码组主键ID', + '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' => '描述信息的具体内容'."\n", + ], + 'avatarUrl' => [ + 'description' => '代码组头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'pathWithNamespace' => [ + 'description' => '路径（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org/test-group-detail', + ], + 'nameWithNamespace' => [ + 'description' => '名称（含父路径）', + 'type' => 'string', + 'example' => 'codeup-test-org / test-group-detail（斜杠两侧有空格）', + ], + 'type' => [ + 'description' => '类型，默认为Group', + 'type' => 'string', + 'example' => 'Group', + ], + 'visibilityLevel' => [ + 'description' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '拥有者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4CA06B0B-5867-5DE6-A0FA-9F39C97B524C\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 36612,\\n \\"name\\": \\"test-group-detail\\",\\n \\"path\\": \\"test-group-detail\\",\\n \\"description\\": \\"描述信息的具体内容\\\\n\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group-detail\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group-detail（斜杠两侧有空格）\\",\\n \\"type\\": \\"Group\\",\\n \\"visibilityLevel\\": 10,\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230\\n }\\n}","type":"json"}]', + 'title' => '查询代码组信息', + ], + 'GetGroupByPath' => [ + 'summary' => '根据代码组全路径查询代码组信息。', + 'path' => '/api/4/groups/find_by_path', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'identity', + 'in' => 'query', + 'schema' => [ + 'description' => '代码组全路径或者代码组ID', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957/test-group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '代码组ID，也是代码组的空间ID', + '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' => 'codeup-test-org / test-group（斜杠两侧有空格）', + ], + 'visibilityLevel' => [ + 'description' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + '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' => '页面访问时的URL', + 'type' => 'string', + 'example' => 'xxx', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'string', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '拥有者ID', + 'type' => 'string', + 'example' => '19230', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"name\\": \\"test-group\\",\\n \\"path\\": \\"test-group\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group（斜杠两侧有空格）\\",\\n \\"visibilityLevel\\": 0,\\n \\"description\\": \\"描述内容\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"xxx\\",\\n \\"parentId\\": \\"26842\\",\\n \\"ownerId\\": \\"19230\\"\\n }\\n}","type":"json"}]', + 'title' => '查询代码组信息（Path）', + ], + 'ListRepositoryGroups' => [ + 'summary' => '查询代码组列表，支持分页、按创建时间和更新时间排序以及关键字搜索。', + 'path' => '/repository/groups/get/all', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'parentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父路径的namespaceId'."\n" + .'- 若查询所有组，那么该值为企业所对应的namespaceId（非organizationId）'."\n" + .'- 若查询某个组下的所有组，那么该值为组所对应的namespaceId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '26842', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，仅有更新时间和创建时间的排序，默认为按照更新时间排序'."\n" + .'- 更新时间：updated_at'."\n" + .'- 创建时间：created_at', + 'type' => 'string', + 'required' => false, + 'example' => 'updated_at', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'includePersonal', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含个人的私有组', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码组ID（组空间的namespaceId）', + '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' => '60de7a6852743a5162b5f957 / test-codeup（斜杠两侧有空格）', + ], + 'pathWithNamespace' => [ + 'description' => '组路径（含父路径）', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957/test-codeup', + ], + 'visibilityLevel' => [ + 'description' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'webUrl' => [ + 'description' => '页面访问时的URL', + 'type' => 'string', + 'example' => '""', + ], + 'type' => [ + 'description' => '组的类型为：Group', + 'type' => 'string', + 'example' => 'Group', + ], + 'description' => [ + 'description' => '代码组的描述信息', + 'type' => 'string', + 'example' => '描述信息的具体内容', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'ownerId' => [ + 'description' => '拥有者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'20：浏览者 '."\n" + .'30：开发者'."\n" + .'40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'projectCount' => [ + 'description' => '组包含的代码库数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'groupCount' => [ + 'description' => '子组的数量（非递归统计）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'updatedAt' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"total\\": 100,\\n \\"result\\": [\\n {\\n \\"id\\": 19285,\\n \\"path\\": \\"test-codeup\\",\\n \\"name\\": \\"test-codeup\\",\\n \\"nameWithNamespace\\": \\"60de7a6852743a5162b5f957 / test-codeup（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"60de7a6852743a5162b5f957/test-codeup\\",\\n \\"visibilityLevel\\": 0,\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"type\\": \\"Group\\",\\n \\"description\\": \\"描述信息的具体内容\\",\\n \\"parentId\\": 26842,\\n \\"ownerId\\": 19230,\\n \\"accessLevel\\": 40,\\n \\"projectCount\\": 10,\\n \\"groupCount\\": 10,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询代码组列表', + ], + 'ListGroupRepositories' => [ + 'summary' => '根据代码组ID查询其组下的代码库列表。', + 'path' => '/repository/groups/{groupId}/projects', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '60ee8a814690c27532d412f8', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码组主键ID', + 'type' => 'string', + 'required' => true, + 'example' => '35117', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字（匹配代码组名称）', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '代码库ID', + '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' => 'codeup-test-org / test-group-repo（斜杠两侧有空格）', + ], + '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' => '可见性'."\n" + .'0：私有，仅代码库成员可见'."\n" + .'10：企业内公开，企业成员可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'starCount' => [ + 'description' => '被收藏的数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'webUrl' => [ + 'description' => '代码库的页面访问地址'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'sshUrl' => [ + 'description' => '代码库的SSH克隆地址', + 'type' => 'string', + 'example' => 'git@xxx:xxx/test/test.git', + ], + 'httpUrl' => [ + 'description' => '代码库的HTTP克隆地址', + 'type' => 'string', + 'example' => 'https://xxx/test/test', + ], + 'description' => [ + 'description' => '代码库描述', + 'type' => 'string', + 'example' => '描述详情内容', + ], + 'privateFlag' => [ + 'description' => '私有库标识'."\n" + ."\n" + .'- true：私有'."\n" + .'- false：企业内公开', + 'type' => 'boolean', + 'example' => 'true', + ], + 'creatorId' => [ + 'description' => '创建者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19238', + ], + 'issuesEnabled' => [ + 'description' => '是否开启issues'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'mergeRequestsEnabled' => [ + 'description' => '是否开启合并请求'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'wikiEnabled' => [ + 'description' => '是否开启wiki'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'namespaceId' => [ + 'description' => '库所属组或者企业空间ID', + 'type' => 'boolean', + 'example' => '100003', + ], + 'snippetsEnabled' => [ + 'description' => '是否开启snippets'."\n" + .'可选值：true / false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'importUrl' => [ + 'description' => '待导入代码库地址（HTTP协议），例如GitHub平台上的代码库地址', + 'type' => 'string', + 'example' => 'http://xxx/x', + ], + 'archived' => [ + 'description' => '归档标识', + 'type' => 'boolean', + 'example' => 'false', + ], + 'commitCount' => [ + 'description' => '代码库的提交数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'isStared' => [ + 'description' => '是否被标星收藏', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9293CBDA-B5BC-5AD6-A8F4-C7873AC7A3DF\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"id\\": 89616,\\n \\"name\\": \\"test-group-repo\\",\\n \\"path\\": \\"test-group-repo\\",\\n \\"nameWithNamespace\\": \\"codeup-test-org / test-group-repo（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"codeup-test-org/test-group-repo\\",\\n \\"lastActivityAt\\": \\"2022-03-18 14:24:54\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"visibilityLevel\\": 0,\\n \\"starCount\\": 0,\\n \\"webUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"sshUrl\\": \\"git@xxx:xxx/test/test.git\\",\\n \\"httpUrl\\": \\"https://xxx/test/test\\",\\n \\"description\\": \\"描述详情内容\\",\\n \\"privateFlag\\": true,\\n \\"creatorId\\": 19238,\\n \\"issuesEnabled\\": true,\\n \\"mergeRequestsEnabled\\": true,\\n \\"wikiEnabled\\": true,\\n \\"namespaceId\\": true,\\n \\"snippetsEnabled\\": false,\\n \\"importUrl\\": \\"http://xxx/x\\",\\n \\"archived\\": false,\\n \\"commitCount\\": 10,\\n \\"isStared\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询代码组下的库列表', + ], + 'UpdatePushReviewOnOff' => [ + 'summary' => '打开或关闭指定代码库的推送评审设置（需要有管理员权限）。', + 'path' => '/repository/{repositoryId}/settings/trunk_mode', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'trunkMode', + 'in' => 'query', + 'schema' => [ + 'description' => '推送评审开关（需要有管理员权限）'."\n" + .'- true：打开'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6177543A-8D54-5736-A93B-E0195A1512CB', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '是否设置成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6177543A-8D54-5736-A93B-E0195A1512CB\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '推送评审模式开关', + ], + 'CreatePushRule' => [ + 'summary' => '创建推送规则。', + 'path' => '/api/v4/projects/{repositoryId}/push_rule', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '187687', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'ruleInfos' => [ + 'description' => '规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '某项规则', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '规则名称，可选值：'."\n" + .'- CommitMessageChecker：提交说明规则'."\n" + .'- CommitAuthorEmailChecker：提交邮箱规则'."\n" + .'- CommitAuthorChecker：提交作者检查'."\n" + .'- CommitCommitterChecker：提交人检查'."\n" + .'- ForcePushChecker：禁止强制推送检查'."\n" + .'- CommitFilesChecker：提交文件限制规则', + 'type' => 'string', + 'required' => false, + 'example' => 'CommitMessageChecker', + ], + 'extraMessage' => [ + 'description' => '在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：'."\n" + .'- 提交说明规则，extraMessage传入检查的正则表达式'."\n" + .'- 提交邮箱规则，extraMessage传入检查的邮箱正则表示'."\n" + .'- 禁止强制推送，extraMessage传入 "disabled"'."\n" + .'- 检查作者规则，extraMessage传入 "on"，若不需要则不传值'."\n" + .'- 检查提交人规则，extraMessage传入 "on"，若不需要则不传值', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'checkerType' => [ + 'description' => '该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：'."\n" + .'- warn：仅警告，允许推送'."\n" + .'- block：禁止推送', + 'type' => 'string', + 'required' => false, + 'example' => 'warn', + ], + 'fileRuleRegexes' => [ + 'description' => '该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制', + 'type' => 'array', + 'items' => [ + 'description' => '文件限制正则表达式', + 'type' => 'string', + 'required' => false, + 'example' => '\\.java$', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '推送规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2077', + ], + 'ruleInfos' => [ + 'description' => '规则信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '规则名称，可选值：'."\n" + ."\n" + .'- CommitMessageChecker：提交说明规则'."\n" + .'- CommitAuthorEmailChecker：提交邮箱规则'."\n" + .'- CommitAuthorChecker：提交作者检查'."\n" + .'- CommitCommitterChecker：提交人检查'."\n" + .'- ForcePushChecker：禁止强制推送检查'."\n" + .'- CommitFilesChecker：提交文件限制规则', + 'type' => 'string', + 'example' => 'ForcePushChecker', + ], + 'checkerType' => [ + 'description' => '该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：'."\n" + ."\n" + .'- warn：仅警告，允许推送'."\n" + .'- block：禁止推送', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：'."\n" + .'- 提交说明规则，extraMessage传入检查的正则表达式'."\n" + .'- 提交邮箱规则，extraMessage传入检查的邮箱正则表示'."\n" + .'- 禁止强制推送，extraMessage传入 "disabled"'."\n" + .'- 检查作者规则，extraMessage传入 "on"，若不需要则不传值'."\n" + .'- 检查提交人规则，extraMessage传入 "on"，若不需要则不传值', + 'type' => 'string', + 'example' => 'disabled', + ], + 'fileRuleRegexes' => [ + 'description' => '该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制', + 'type' => 'array', + 'items' => [ + 'description' => '文件限制正则表达式', + 'type' => 'string', + 'example' => '\\.java$'."\n", + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 2077,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"ForcePushChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"disabled\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\\\n\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n}","type":"json"}]', + 'title' => '创建推送规则', + 'description' => '需要代码库管理员以上权限。', + ], + 'UpdatePushRule' => [ + 'summary' => '更新指定的推送规则，更新方式为覆盖式更新，若是新增规则项，需要确保原有的也存在，否则会被新内容覆盖。', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'pushRuleId', + 'in' => 'path', + 'schema' => [ + 'description' => '推送规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2077', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'ruleInfos' => [ + 'description' => '规则信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '规则名称，可选值：'."\n" + ."\n" + .'- CommitMessageChecker：提交说明规则'."\n" + .'- CommitAuthorEmailChecker：提交邮箱规则'."\n" + .'- CommitAuthorChecker：提交作者检查'."\n" + .'- CommitCommitterChecker：提交人检查'."\n" + .'- ForcePushChecker：禁止强制推送检查'."\n" + .'- CommitFilesChecker：提交文件限制规则', + 'type' => 'string', + 'required' => false, + 'example' => 'CommitAuthorChecker', + ], + 'extraMessage' => [ + 'description' => '在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：'."\n" + .'- 提交说明规则，extraMessage传入检查的正则表达式'."\n" + .'- 提交邮箱规则，extraMessage传入检查的邮箱正则表示'."\n" + .'- 禁止强制推送，extraMessage传入 "disabled"'."\n" + .'- 检查作者规则，extraMessage传入 "on"，若不需要则不传值'."\n" + .'- 检查提交人规则，extraMessage传入 "on"，若不需要则不传值', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'checkerType' => [ + 'description' => '该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：'."\n" + .'- warn：仅警告，允许推送'."\n" + .'- block：禁止推送', + 'type' => 'string', + 'required' => false, + 'example' => 'warn', + ], + 'fileRuleRegexes' => [ + 'description' => '该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制', + 'type' => 'array', + 'items' => [ + 'description' => '文件限制正则表达式', + 'type' => 'string', + 'required' => false, + 'example' => '\\.java$', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '推送规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30815', + ], + 'ruleInfos' => [ + 'description' => '规则信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '规则名称，可选值：'."\n" + ."\n" + .'- CommitMessageChecker：提交说明规则'."\n" + .'- CommitAuthorEmailChecker：提交邮箱规则'."\n" + .'- CommitAuthorChecker：提交作者检查'."\n" + .'- CommitCommitterChecker：提交人检查'."\n" + .'- ForcePushChecker：禁止强制推送检查'."\n" + .'- CommitFilesChecker：提交文件限制规则', + 'type' => 'string', + 'example' => 'CommitAuthorChecker', + ], + 'checkerType' => [ + 'description' => '该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：'."\n" + ."\n" + .'- warn：仅警告，允许推送'."\n" + .'- block：禁止推送', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：'."\n" + .'- 提交说明规则，extraMessage传入检查的正则表达式'."\n" + .'- 提交邮箱规则，extraMessage传入检查的邮箱正则表示'."\n" + .'- 禁止强制推送，extraMessage传入 "disabled"'."\n" + .'- 检查作者规则，extraMessage传入 "on"，若不需要则不传值'."\n" + .'- 检查提交人规则，extraMessage传入 "on"，若不需要则不传值', + 'type' => 'string', + 'example' => 'on', + ], + 'fileRuleRegexes' => [ + 'description' => '该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制', + 'type' => 'array', + 'items' => [ + 'description' => '文件限制正则表达式', + 'type' => 'string', + 'example' => '\\.java$', + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 30815,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"CommitAuthorChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"on\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n}","type":"json"}]', + 'title' => '更新推送规则', + 'description' => '需要代码库管理员以上的权限。', + ], + 'DeletePushRule' => [ + 'summary' => '删除指定的推送规则。', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/{pushRuleId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:'."\n" + .'//devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'pushRuleId', + 'in' => 'path', + 'schema' => [ + 'description' => '推送规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2077', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'InvalidParam.NotFound', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"InvalidParam.NotFound\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '删除推送规则', + 'description' => '需要有代码库管理员以上的权限。', + ], + 'ListPushRules' => [ + 'summary' => '查询指定代码库下的推送规则列表，无分页。', + 'path' => '/api/v4/projects/{repositoryId}/push_rule/push_rules/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '889910', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '推送规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2077', + ], + 'ruleInfos' => [ + 'description' => '规则信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息', + 'type' => 'object', + 'properties' => [ + 'checkerName' => [ + 'description' => '规则名称，可选值：'."\n" + .'- CommitMessageChecker：提交说明规则'."\n" + .'- CommitAuthorEmailChecker：提交邮箱规则'."\n" + .'- CommitAuthorChecker：提交作者检查'."\n" + .'- CommitCommitterChecker：提交人检查'."\n" + .'- ForcePushChecker：禁止强制推送检查'."\n" + .'- CommitFilesChecker：提交文件限制规则', + 'type' => 'string', + 'example' => 'CommitFilesChecker', + ], + 'checkerType' => [ + 'description' => '该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：'."\n" + ."\n" + .'- warn：仅警告，允许推送'."\n" + .'- block：禁止推送', + 'type' => 'string', + 'example' => 'warn', + ], + 'extraMessage' => [ + 'description' => '在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：'."\n" + .'- 提交说明规则，extraMessage传入检查的正则表达式'."\n" + .'- 提交邮箱规则，extraMessage传入检查的邮箱正则表示'."\n" + .'- 禁止强制推送，extraMessage传入 "disabled"'."\n" + .'- 检查作者规则，extraMessage传入 "on"，若不需要则不传值'."\n" + .'- 检查提交人规则，extraMessage传入 "on"，若不需要则不传值', + 'type' => 'string', + 'example' => '""', + ], + 'fileRuleRegexes' => [ + 'description' => '该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制', + 'type' => 'array', + 'items' => [ + 'description' => '文件限制正则表达式', + 'type' => 'string', + 'example' => '\\.java$', + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + 'gmtModified' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2023-09-03T18:20:06+08:00', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"id\\": 2077,\\n \\"ruleInfos\\": [\\n {\\n \\"checkerName\\": \\"CommitFilesChecker\\",\\n \\"checkerType\\": \\"warn\\",\\n \\"extraMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fileRuleRegexes\\": [\\n \\"\\\\\\\\.java$\\"\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"2023-09-03T18:20:06+08:00\\",\\n \\"gmtModified\\": \\"2023-09-03T18:20:06+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询推送规则列表', + 'description' => '需要有代码库管理员以上的权限。', + ], + 'CreateDeployKey' => [ + 'summary' => '在代码库中创建新的部署密钥。', + 'path' => '/repository/{repositoryId}/keys/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2813489', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '部署密钥标题', + 'type' => 'string', + 'required' => true, + 'example' => '测试密钥', + ], + 'key' => [ + 'description' => '部署密钥'."\n" + .'><notice>部署密钥不能与SSH密钥相同，详情见：https://help.aliyun.com/document_detail/153709.html?spm=a2cl9.codeup_devops2020_goldlog_projectSettings.0.0.50c83b53WLYIBj'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '""', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '部署密钥ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '502385', + ], + 'title' => [ + 'description' => '部署密钥标题', + 'type' => 'string', + 'example' => '测试密钥', + ], + 'key' => [ + 'description' => '部署密钥', + 'type' => 'string', + 'example' => '""', + ], + 'fingerprint' => [ + 'description' => '部署密钥指纹', + 'type' => 'string', + 'example' => 'xx:xx:xx:xx', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 502385,\\n \\"title\\": \\"测试密钥\\",\\n \\"key\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fingerprint\\": \\"xx:xx:xx:xx\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\"\\n }\\n}","type":"json"}]', + 'title' => '创建部署密钥', + ], + 'EnableDeployKey' => [ + 'summary' => '启用代码库中已有的部署密钥。', + 'path' => '/repository/{repositoryId}/keys/{keyId}/enable', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'repositoryId', + 'in' => 'path', + 'schema' => [ + 'description' => '代码库ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2709413', + ], + ], + [ + 'name' => 'keyId', + 'in' => 'path', + 'schema' => [ + 'description' => '部署密钥ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50998', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '启用密钥是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"result\\": true\\n }\\n}","type":"json"}]', + 'title' => '启用部署密钥', + ], + 'CreateUserKey' => [ + 'summary' => '创建当前用户的SSH-Key密钥。', + 'path' => '/api/v3/user/keys/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'description' => 'SSH-Key的公钥串', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'title' => [ + 'description' => 'SSH-Key的标题信息', + 'type' => 'string', + 'required' => true, + 'example' => 'SSH Title', + ], + 'keyScope' => [ + 'description' => '必填，作用范围，可选值：ALL、READ'."\n" + ."\n" + .'- ALL：全部（读/写操作包括 clone/pull/push 等）'."\n" + ."\n" + .'- READ：只读（仅支持 clone/pull ）', + 'type' => 'string', + 'required' => true, + 'example' => 'ALL', + ], + 'expireTime' => [ + 'description' => '过期时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-12 12:00:00', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Key的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11072', + ], + 'title' => [ + 'description' => 'SSH密钥的标题', + 'type' => 'string', + 'example' => 'My Title', + ], + 'publicKey' => [ + 'description' => 'SSH-Key的公钥串', + 'type' => 'string', + 'example' => 'xxx', + ], + 'fingerPrint' => [ + 'description' => '指纹信息', + 'type' => 'string', + 'example' => 'xxx', + ], + 'keyScope' => [ + 'description' => '作用范围，可选值：ALL、READ'."\n" + ."\n" + .'- ALL：全部（读/写操作包括 clone/pull/push 等）'."\n" + ."\n" + .'- READ：只读（仅支持 clone/pull ）', + 'type' => 'string', + 'example' => 'ALL', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'expireTime' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + 'lastUsedTime' => [ + 'description' => '上次使用时间', + 'type' => 'string', + 'example' => '2022-03-12 12:00:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 11072,\\n \\"title\\": \\"My Title\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"keyScope\\": \\"ALL\\",\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"expireTime\\": \\"2022-03-12 12:00:00\\",\\n \\"lastUsedTime\\": \\"2022-03-12 12:00:00\\"\\n }\\n}","type":"json"}]', + 'title' => '创建用户SSH密钥', + ], + 'DeleteUserKey' => [ + 'summary' => '为当前用户删除指定的SSH密钥。', + 'path' => '/api/v3/user/keys/{keyId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。 '."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + [ + 'name' => 'keyId', + 'in' => 'path', + 'schema' => [ + 'description' => 'SSH密钥的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50998', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'SSH密钥的主键ID', + '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' => 'SSH密钥的标题', + 'type' => 'string', + 'example' => '密钥标题', + ], + 'fingerPrint' => [ + 'description' => '指纹信息', + 'type' => 'string', + 'example' => 'xxx', + ], + 'shaContext' => [ + 'description' => 'SHA1加密的公钥串加密信息', + 'type' => 'string', + 'example' => 'xxx', + ], + 'publicKey' => [ + 'description' => 'SSH-Key的公钥串', + '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' => '作用范围，可选值：ALL、READ'."\n" + .'- ALL：全部（读/写操作包括 clone/pull/push 等）'."\n" + ."\n" + .'- READ：只读（仅支持 clone/pull ）', + 'type' => 'string', + 'example' => 'ALL', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 50998,\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"title\\": \\"密钥标题\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"shaContext\\": \\"xxx\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"context\\": \\"xxx\\",\\n \\"expireTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"lastUsedTime\\": \\"2022-03-18 14:24:54\\\\n\\",\\n \\"keyScope\\": \\"ALL\\"\\n }\\n}","type":"json"}]', + 'title' => '删除指定的SSH密钥', + ], + 'ListUserKeys' => [ + 'summary' => '查询当前用户的SSH密钥列表。', + 'path' => '/api/v3/user/keys', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为desc'."\n" + ."\n" + .'- asc：按排序字段升序排序'."\n" + ."\n" + .'- desc：按排序字段降序排序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，默认值为created_at'."\n" + .'- created_at：创建时间'."\n" + ."\n" + .'- updated_at：更新时间', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'SSH密钥的主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'title' => [ + 'description' => 'SSH密钥的标题', + 'type' => 'string', + 'example' => 'My Title', + ], + 'publicKey' => [ + 'description' => 'SSH-Key的公钥串', + 'type' => 'string', + 'example' => 'xxx', + ], + 'fingerPrint' => [ + 'description' => '指纹信息', + 'type' => 'string', + 'example' => 'xxx', + ], + 'keyScope' => [ + 'description' => '作用范围，可选值：ALL、READ'."\n" + .'- ALL：全部（读/写操作包括 clone/pull/push 等）'."\n" + ."\n" + .'- READ：只读（仅支持 clone/pull ）', + 'type' => 'string', + 'example' => 'ALL', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'expireTime' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + 'lastUsedTime' => [ + 'description' => '上次使用时间', + 'type' => 'string', + 'example' => '2022-03-18 14:24:54', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"id\\": 5240,\\n \\"title\\": \\"My Title\\",\\n \\"publicKey\\": \\"xxx\\",\\n \\"fingerPrint\\": \\"xxx\\",\\n \\"keyScope\\": \\"ALL\\",\\n \\"createdAt\\": \\"2022-03-18 14:24:54\\",\\n \\"expireTime\\": \\"2022-03-18 14:24:54\\",\\n \\"lastUsedTime\\": \\"2022-03-18 14:24:54\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询SSH密钥列表', + ], + 'ListSearchSourceCode' => [ + 'summary' => '根据筛选条件搜索相应的代码片段。', + 'path' => '/search/code', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'page' => [ + 'description' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'sort' => [ + 'description' => '排序方式，默认为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'order' => [ + 'description' => '排序字段，默认为default'."\n" + .'- default：默认排序，即综合排序'."\n" + .'- created_at：创建时间'."\n" + .'- updated_at：更新时间'."\n" + .'- star：收藏数'."\n" + .'- like：点赞数'."\n" + .'- comment：评论数'."\n" + .'- reply：回复数', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'scope' => [ + 'description' => '搜索范围，默认为all'."\n" + .'- all：全局范围，公开库以及有权限的private库'."\n" + .'- mine：只作为库或组成员，并且有读权限', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '代码仓库查询条件', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '代码库的全路径，例如：organization/group/repo'."\n" + ."\n" + .'> 如果有多个代码库路径，使用英文逗号","隔开', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'operatorType' => [ + 'description' => '查询条件类型'."\n" + .'- equal：等于'."\n" + .'- unequal：不等于'."\n" + .'- and：与'."\n" + .'- or：或'."\n" + .'- not：非', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '查询匹配类型'."\n" + .'- term：精确匹配'."\n" + .'- regex：正则匹配'."\n" + .'- phrase：短语匹配，默认方式'."\n" + .'- wildcard：模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + 'filePath' => [ + 'description' => '代码文件路径，支持正则表达式', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '文件的全路径，例如：organization/group/repo/file'."\n" + ."\n" + .'> 如多个文件全路径，使用英文逗号","隔开', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo/test.java', + ], + 'operatorType' => [ + 'description' => '查询条件类型'."\n" + .'- equal：等于'."\n" + .'- unequal：不等于'."\n" + .'- and：与'."\n" + .'- or：或'."\n" + .'- not：非', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '查询匹配类型'."\n" + .'- term：精确匹配'."\n" + .'- regex：正则匹配'."\n" + .'- phrase：短语匹配，默认方式'."\n" + .'- wildcard：模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + 'language' => [ + 'description' => '编程语言', + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + 'isCodeBlock' => [ + 'description' => '是否查询代码方法块数据，如类、方法等', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => ' '."\n" + .'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '文档ID', + 'type' => 'string', + 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/spec/frontend/snippets/test_utils.js', + ], + 'highlightTextMap' => [ + 'description' => '高亮文本信息', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '高亮企业ID', + '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' => 'ES返回的源信息', + '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' => '最近一次commit时间', + 'type' => 'string', + 'example' => '2022-10-10 10:00:00', + ], + 'branch' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + 'organizationId' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\t\\\\nSYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"60d54f3daccf2bbd6659f3ad/gitlabhq/master/spec/frontend/snippets/test_utils.js\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\",\\n \\"fileName\\": \\"test.java\\",\\n \\"clob\\": \\"xxx\\",\\n \\"language\\": \\"java\\"\\n },\\n \\"source\\": {\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"fileName\\": \\"test_utils.js\\",\\n \\"filePath\\": \\"spec/frontend/snippets/test_utils.js\\",\\n \\"language\\": \\"JavaScript\\",\\n \\"checkinDate\\": \\"2022-10-10 10:00:00\\",\\n \\"branch\\": \\"master\\",\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '搜索代码片段数据', + ], + 'ListSearchRepository' => [ + 'summary' => '根据查询条件搜索代码仓库数据。', + 'path' => '/search/repo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '61e54b0e0bb300d827e1ae27', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'aliyunPk' => [ + 'description' => '创建人的阿里云账号ID，仅支持单人筛选', + 'type' => 'string', + 'required' => false, + 'example' => '1840004904455497', + ], + 'visibilityLevel' => [ + 'description' => '代码库的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'page' => [ + 'description' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'sort' => [ + 'description' => '排序方式，默认为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'order' => [ + 'description' => '排序字段，默认为default'."\n" + .'- default：默认排序，即综合排序'."\n" + .'- created_at：创建时间'."\n" + .'- updated_at：更新时间'."\n" + .'- star：收藏数'."\n" + .'- like：点赞数'."\n" + .'- comment：评论数'."\n" + .'- reply：回复数', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'scope' => [ + 'description' => '搜索范围，默认为all'."\n" + .'- all：全局范围，公开库以及有权限的private库'."\n" + .'- mine：只作为库或组成员，并且有读权限', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '代码仓库查询条件', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '代码库的全路径，例如：organization/group/repo'."\n" + .'> 若有多个代码库全路径，使用英文逗号","隔开', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo', + ], + 'operatorType' => [ + 'description' => '查询条件类型'."\n" + .'- equal：等于'."\n" + .'- unequal：不等于'."\n" + .'- and：与'."\n" + .'- or：或'."\n" + .'- not：非', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '查询匹配类型'."\n" + .'- term：精确匹配'."\n" + .'- regex：正则匹配'."\n" + .'- phrase：短语匹配，默认方式'."\n" + .'- wildcard：模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'result' => [ + 'description' => '返回列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回的仓库数据', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '文档ID', + 'type' => 'string', + 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + 'highlightTextMap' => [ + 'description' => '高亮文本信息', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '高亮企业ID', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + 'creatorUserId' => [ + 'description' => '创建人的userId，此处为用户的云效ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'repoPath' => [ + 'description' => '代码库完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'repoNameWithNamespace' => [ + 'description' => '代码库完整名称（带完整组名称）', + 'type' => 'string', + 'example' => 'codeup/test-repo', + ], + 'readMe' => [ + 'description' => 'readme文件高亮信息', + 'type' => 'string', + 'example' => 'xx', + ], + 'description' => [ + 'description' => '代码库描述', + 'type' => 'string', + 'example' => '描述内容', + ], + ], + ], + 'source' => [ + 'description' => 'ES返回的源信息', + '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' => '可见性'."\n" + .'- 0：私有，仅代码库成员可见'."\n" + .'- 10：企业内公开，企业成员可见', + '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' => 'readme文件的内容', + 'type' => 'string', + 'example' => 'xxx', + ], + 'organizationId' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'example' => '62a94a8611fc0f0c9e2a7bc1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"total\\": 30,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"\\\\t\\\\n60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\",\\n \\"creatorUserId\\": \\"xxx\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"repoNameWithNamespace\\": \\"codeup/test-repo\\",\\n \\"readMe\\": \\"xx\\",\\n \\"description\\": \\"描述内容\\"\\n },\\n \\"source\\": {\\n \\"repoName\\": \\"test-repo\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"description\\": \\"描述内容\\",\\n \\"visibilityLevel\\": 0,\\n \\"createTime\\": \\"2022-10-10 10:10:10\\",\\n \\"lastActivityTime\\": \\"2022-11-11 11:11:11\\",\\n \\"readMe\\": \\"xxx\\",\\n \\"organizationId\\": \\"62a94a8611fc0f0c9e2a7bc1\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '搜索代码仓库数据', + ], + 'ListSearchCommit' => [ + 'summary' => '根据筛选条件搜索提交的相关数据。', + 'path' => '/search/commit', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'keyword' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'page' => [ + 'description' => '页码 '."\n" + .'默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页大小'."\n" + .'默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'order' => [ + 'description' => '排序字段，默认为default'."\n" + .'- default：默认排序，即综合排序'."\n" + .'- created_at：创建时间'."\n" + .'- updated_at：更新时间'."\n" + .'- star：收藏数'."\n" + .'- like：点赞数'."\n" + .'- comment：评论数'."\n" + .'- reply：回复数', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'sort' => [ + 'description' => '排序方式，默认为desc'."\n" + .'- desc：降序'."\n" + .'- asc：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'scope' => [ + 'description' => '搜索范围，默认为all'."\n" + .'- all：全局范围，公开库以及有权限的private库'."\n" + .'- mine：只作为库或组成员，并且有读权限', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'repoPath' => [ + 'description' => '代码仓库查询条件', + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'description' => '代码库的全路径，例如：organization/group/repo'."\n" + ."\n" + .'> 若有多个代码库全路径，使用英文逗号","隔开', + 'type' => 'string', + 'required' => false, + 'example' => 'orgId/test-group/spring-boot-demo', + ], + 'operatorType' => [ + 'description' => '查询条件类型'."\n" + .'- equal：等于'."\n" + .'- unequal：不等于'."\n" + .'- and：与'."\n" + .'- or：或'."\n" + .'- not：非', + 'type' => 'string', + 'required' => false, + 'example' => 'equal', + ], + 'matchType' => [ + 'description' => '查询匹配类型'."\n" + .'- term：精确匹配'."\n" + .'- regex：正则匹配'."\n" + .'- phrase：短语匹配，默认方式'."\n" + .'- wildcard：模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'term', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回的提交数据', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '文档ID', + 'type' => 'string', + 'example' => ' '."\n" + .'60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + 'highlightTextMap' => [ + 'description' => '高亮文本信息', + 'type' => 'object', + 'properties' => [ + 'commitId' => [ + 'description' => '提交ID', + 'type' => 'string', + 'example' => 'df1b701cb0f3f7ca92320d49d31995821f2d045c', + ], + 'title' => [ + 'description' => '提交标题，提交的第一行内容', + 'type' => 'string', + 'example' => '提交标题', + ], + 'commitMessage' => [ + 'description' => '提交的具体内容', + 'type' => 'string', + 'example' => '提交内容', + ], + 'organizationId' => [ + 'description' => '企业ID', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + 'source' => [ + 'description' => 'ES返回的源信息', + 'type' => 'object', + 'properties' => [ + 'commitId' => [ + 'description' => '提交ID', + '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' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'example' => '61133b011bd96aa110f1b500', + ], + 'author' => [ + 'description' => '提交者', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '提交者的姓名', + 'type' => 'string', + 'example' => '云效', + ], + 'email' => [ + 'description' => '提交者的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"total\\": 10,\\n \\"result\\": [\\n {\\n \\"docId\\": \\"\\\\t\\\\n60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb\\",\\n \\"highlightTextMap\\": {\\n \\"commitId\\": \\"df1b701cb0f3f7ca92320d49d31995821f2d045c\\",\\n \\"title\\": \\"提交标题\\",\\n \\"commitMessage\\": \\"提交内容\\",\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n },\\n \\"source\\": {\\n \\"commitId\\": \\"a748f5ecb17a93900d4808944bfcc96dc158ee2d\\",\\n \\"title\\": \\"提交标题\\",\\n \\"commitMessage\\": \\"提交信息\\",\\n \\"authorTime\\": \\"2022-11-11 11:11:11\\",\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"organizationId\\": \\"61133b011bd96aa110f1b500\\",\\n \\"author\\": {\\n \\"name\\": \\"云效\\",\\n \\"email\\": \\"[email protected]\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '搜索代码提交数据', + ], + 'GetSearchCodePreview' => [ + 'summary' => '根据文档ID和关键字获取到预览代码片段。', + 'path' => '/search/code_preview', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '627475075b46541dd2ff01bc', + ], + ], + [ + 'name' => 'docId', + 'in' => 'query', + 'schema' => [ + 'description' => '文档ID', + 'type' => 'string', + 'required' => true, + 'example' => '60d54f3daccf2bbd6659f3ad/gitlabhq/master/config/environments/test.rb', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'isDsl', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是DSL搜索', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => ' '."\n" + .'调用是否成功'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => 'ES的搜索结果', + 'type' => 'object', + 'properties' => [ + 'docId' => [ + 'description' => '文档ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'highlightTextMap' => [ + 'description' => '高亮文本信息', + 'type' => 'object', + 'properties' => [ + 'organizationId' => [ + 'description' => '云效企业ID', + 'type' => 'string', + 'example' => '5ffd468b1e45db3c1cc26ad6', + ], + 'fileName' => [ + 'description' => '高亮文件名', + 'type' => 'string', + 'example' => 'test.rb', + ], + 'clob' => [ + 'description' => '命中的文件内容中的某个片段', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'source' => [ + 'description' => 'ES返回的源信息', + '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' => '最近一次commit时间', + 'type' => 'string', + 'example' => '2022-12-12 12:12:12', + ], + 'branch' => [ + 'description' => '分支名称', + 'type' => 'string', + 'example' => 'master', + ], + 'organizationId' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'example' => '5f9f9f6122a8c7ff3934f99a', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"docId\\": \\"xxx\\",\\n \\"highlightTextMap\\": {\\n \\"organizationId\\": \\"5ffd468b1e45db3c1cc26ad6\\",\\n \\"fileName\\": \\"test.rb\\",\\n \\"clob\\": \\"xxx\\"\\n },\\n \\"source\\": {\\n \\"repoPath\\": \\"codeup/test-repo\\",\\n \\"fileName\\": \\"test.rb\\",\\n \\"filePath\\": \\"config/environments/test.rb\\",\\n \\"language\\": \\"Ruby\\",\\n \\"checkinDate\\": \\"2022-12-12 12:12:12\\",\\n \\"branch\\": \\"master\\",\\n \\"organizationId\\": \\"5f9f9f6122a8c7ff3934f99a\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询预览代码片段', + ], + 'GetCodeupOrganization' => [ + 'summary' => '根据企业标识（云效企业ID或者企业路径）获取Codeup侧的企业信息。', + 'path' => '/api/organization/{identity}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'identity', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业ID或企业路径，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'namespaceId' => [ + 'description' => '库所属组或者企业空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'userRole' => [ + 'description' => '用户在企业中的角色 '."\n" + .'- ORG_MEMBER：企业内成员'."\n" + .'- ORG_ADMIN：企业管理员'."\n" + .'- ORG_OWNER：企业拥有者'."\n" + .'- ORG_EXTERNAL_MEMBER：企业外部成员'."\n" + .'- NO_ACCESS：无权限'."\n" + .'- ADMIN：超级管理员', + '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' => '主键ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3624', + ], + 'organizationId' => [ + 'description' => '企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError.UnKnownError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"namespaceId\\": 100003,\\n \\"userRole\\": \\"ORG_MEMBER\\",\\n \\"path\\": \\"test-codeup\\",\\n \\"createdAt\\": \\"2022-03-12 12:00:00\\",\\n \\"updatedAt\\": \\"2022-03-18 14:24:54\\",\\n \\"id\\": 3624,\\n \\"organizationId\\": \\"60de7a6852743a5162b5f957\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCodeupOrganizationResponse>\\n <ErrorMessage>The specified product does not exist.</ErrorMessage>\\n <RequestId>88694059-DD0C-52BD-B6F2-8501C7B666F9</RequestId>\\n <ErrorCode>500</ErrorCode>\\n <Success>true</Success>\\n <Result>\\n <NamespaceId>124</NamespaceId>\\n <UserRole>ORG_MEMBER</UserRole>\\n <Path>yunxiao-test-org</Path>\\n <CreatedAt>2020-10-26T17:35:16+08:00</CreatedAt>\\n <UpdatedAt>2020-10-26T17:35:16+08:00</UpdatedAt>\\n <Id>53424</Id>\\n <OrganizationId>5f96984d93de7825187241c9</OrganizationId>\\n </Result>\\n</GetCodeupOrganizationResponse>","errorExample":""}]', + 'title' => '查询Codeup仓库所属企业信息', + ], + 'ListOrganizations' => [ + 'summary' => '查询当前用户的企业列表。', + 'path' => '/organizations/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'agp_adf6bc4433173ab3cb43195b6ff9213d', + ], + ], + [ + 'name' => 'accessLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '用户权限，用于查询指定权限的企业列表'."\n" + .'- 5：企业外部成员'."\n" + .'- 15：企业成员'."\n" + .'- 60：企业管理员'."\n" + .'- 70：企业拥有者', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'minAccessLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '最小用户权限，用于查询用户权限大于等于该字段设置的企业列表'."\n" + .'- 5：企业外部成员'."\n" + .'- 15：企业成员'."\n" + .'- 60：企业管理员'."\n" + .'- 70：企业拥有者'."\n" + ."\n" + .'> `minAccessLevel优先生效，不传minAccessLevel时accessLevel参数生效`', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '95FE5953-FF5B-5F80-94AD-FFF97D990FE0', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回的企业列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个企业信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '企业主键ID'."\n" + ."\n\n" + .'> 无业务实际意义，且在企业未开通Codeup时，该值为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5240', + ], + 'accessLevel' => [ + 'description' => '用户在企业中的权限'."\n" + .'- 5：企业外部成员'."\n" + .'- 15：企业成员'."\n" + .'- 60：企业管理员'."\n" + .'- 70：企业拥有者', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'organizationId' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'example' => '60de7a6852743a5162b5f957', + ], + 'organizationName' => [ + 'description' => '企业名称', + 'type' => 'string', + 'example' => '云效Codeup', + ], + 'organizationRole' => [ + 'description' => '用户在企业中的角色'."\n" + ."\n" + .'- ORG_EXTERNAL_MEMBER：企业外部成员'."\n" + ."\n" + .'- ORG_MEMBER：企业成员'."\n" + ."\n" + .'- ORG_ADMIN：企业管理员'."\n" + .'- ORG_OWNER：企业拥有者', + 'type' => 'string', + 'example' => 'ORG_ADMIN', + ], + 'organizationAlias' => [ + 'description' => '企业别名'."\n" + ."\n" + .'> 若企业开通了Codeup，那么企业别名一般有值；若没有开通，则为空', + 'type' => 'string', + 'example' => 'alias-云效Codeup', + ], + 'namespaceId' => [ + 'description' => '企业空间ID', + 'type' => 'string', + 'example' => '600002', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询用户的企业列表', + ], + 'GetUserInfo' => [ + 'summary' => '该接口用于获取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' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n\n" + .'><notice>'."\n" + .'与其他接口不同在于，此处的企业ID不是必传的'."\n" + .'- 不传企业ID，返回的name为个人设置中姓名'."\n" + .'- 传企业ID，返回的name为用户企业姓名></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '61e54b0e0bb300d827e1ae27', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => 'Codeup用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4205', + ], + 'name' => [ + 'description' => '用户姓名或用户在企业中设置的姓名', + 'type' => 'string', + 'example' => '云效Codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'my-codeup-login-account', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"result\\": {\\n \\"id\\": 4205,\\n \\"name\\": \\"云效Codeup\\",\\n \\"username\\": \\"my-codeup-login-account\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\"\\n }\\n}","type":"json"}]', + 'title' => '查询当前用户信息', + ], + 'ListUserResources' => [ + 'summary' => '获取指定用户名下的有权限的代码库和代码组信息，以及角色信息，支持分页，以用户维度进行分页。请注意，仅限企业管理员以上权限的用户可调用。', + 'path' => '/api/v4/user/vision/user_resources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => false, + 'example' => 'f0b1e61db5961df5975a93f9129d2513'."\n", + ], + ], + [ + 'name' => 'userIds', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '用户的阿里云账号ID列表，多个账号以逗号隔开', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1，从第1页开始', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为20，取值范围【1,100】', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A35869D5-BB29-5F84-A4DD-B09985EA2AFA', + ], + 'success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'success', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'result' => [ + 'description' => '返回结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'userInfo' => [ + 'description' => '用户信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19230', + ], + 'name' => [ + 'description' => '用户名称', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'username' => [ + 'description' => '用户登录名', + 'type' => 'string', + 'example' => 'test-codeup', + ], + 'state' => [ + 'description' => '用户状态，可选值：'."\n" + .'- active'."\n" + .'- blocked', + 'type' => 'string', + 'example' => 'active', + ], + 'avatarUrl' => [ + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100', + ], + 'email' => [ + 'description' => '用户邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'groupInfos' => [ + 'description' => '用户有权限的代码组列表', + 'type' => 'array', + 'items' => [ + 'description' => '代码组与角色信息', + 'type' => 'object', + 'properties' => [ + 'groupInfo' => [ + 'description' => '代码组信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码组ID', + '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' => 'test-org / test-group（斜杠两侧有空格）', + ], + 'pathWithNamespace' => [ + 'description' => '代码组完整路径（含父路径）', + 'type' => 'string', + 'example' => 'test-org/test-group', + ], + 'parentId' => [ + 'description' => '父路径ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1183319', + ], + 'ownerId' => [ + 'description' => '代码组拥有者ID', + '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' => '代码组的可见性'."\n" + .'- 0：私有'."\n" + .'- 10：企业可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'description' => [ + 'description' => '代码组的描述信息', + 'type' => 'string', + 'example' => 'test-group', + ], + ], + ], + 'groupRole' => [ + 'description' => '用户在代码组的角色信息', + 'type' => 'object', + 'properties' => [ + 'sourceId' => [ + 'description' => '关联的ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35268', + ], + 'sourceType' => [ + 'description' => '关联的类型，可选值：'."\n" + .'- Project：指代码库'."\n" + .'- Namespace：指代码组', + 'type' => 'string', + 'example' => 'Namespace', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'- 20：浏览者'."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'cnRoleName' => [ + 'description' => '角色中文名'."\n" + .'- 浏览者'."\n" + .'- 开发者'."\n" + .'- 管理员', + 'type' => 'string', + 'example' => '管理员', + ], + 'enRoleName' => [ + 'description' => '角色英文名'."\n" + .'- Viewer - 浏览者'."\n" + .'- Developer - 开发者'."\n" + .'- Admin - 管理员', + 'type' => 'string', + 'example' => 'Admin', + ], + ], + ], + ], + ], + ], + 'repositoryInfos' => [ + 'description' => '用户有权限的代码库列表', + 'type' => 'array', + 'items' => [ + 'description' => '代码库与角色信息', + 'type' => 'object', + 'properties' => [ + 'repositoryInfo' => [ + 'description' => '代码库信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '代码库ID', + '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' => 'test-org / test-group / test-repo（斜杠两侧有空格）', + ], + 'pathWithNamespace' => [ + 'description' => '代码库完整路径（含完整组路径）', + 'type' => 'string', + 'example' => 'test-org/test-group/test-repo', + ], + 'visibilityLevel' => [ + 'description' => '可见性'."\n" + .'- 0：私有，仅代码库成员可见'."\n" + .'- 10：企业内公开，企业成员可见', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'lastActivityAt' => [ + 'description' => '最后活跃时间', + 'type' => 'string', + 'example' => '2022-01-14T21:08:26+08:00'."\n", + ], + 'namespaceId' => [ + 'description' => '上级路径的ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600002', + ], + 'accessLevel' => [ + 'description' => '成员权限'."\n" + .'- 20：浏览者 '."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + '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' => '创建者ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12679', + ], + 'encrypted' => [ + 'description' => '加密标识', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'repositoryRole' => [ + 'description' => '用户在代码库的角色信息', + 'type' => 'object', + 'properties' => [ + 'sourceId' => [ + 'description' => '来源ID，指代码库或代码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37229', + ], + 'sourceType' => [ + 'description' => '关联的类型，可选值：'."\n" + .'- Project：指代码库'."\n" + .'- Namespace：指代码组', + 'type' => 'string', + 'example' => 'Project', + ], + 'accessLevel' => [ + 'description' => '权限类型'."\n" + .'- 20：浏览者 '."\n" + .'- 30：开发者'."\n" + .'- 40：管理员', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'cnRoleName' => [ + 'description' => '角色中文名'."\n" + ."\n" + .'- 浏览者'."\n" + .'- 开发者'."\n" + .'- 管理员', + 'type' => 'string', + 'example' => '管理员', + ], + 'enRoleName' => [ + 'description' => '角色英文名'."\n" + ."\n" + .'- Viewer - 浏览者'."\n" + .'- Developer - 开发者'."\n" + .'- Admin - 管理员', + 'type' => 'string', + 'example' => 'Admin', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A35869D5-BB29-5F84-A4DD-B09985EA2AFA\\",\\n \\"success\\": true,\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"success\\",\\n \\"total\\": 2,\\n \\"result\\": [\\n {\\n \\"userInfo\\": {\\n \\"id\\": 19230,\\n \\"name\\": \\"test-codeup\\",\\n \\"username\\": \\"test-codeup\\",\\n \\"state\\": \\"active\\",\\n \\"avatarUrl\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100\\",\\n \\"email\\": \\"[email protected]\\"\\n },\\n \\"groupInfos\\": [\\n {\\n \\"groupInfo\\": {\\n \\"id\\": 35268,\\n \\"name\\": \\"test-group\\",\\n \\"path\\": \\"test-group\\",\\n \\"nameWithNamespace\\": \\"test-org / test-group（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"test-org/test-group\\",\\n \\"parentId\\": 1183319,\\n \\"ownerId\\": 1234,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"visibilityLevel\\": 0,\\n \\"description\\": \\"test-group\\"\\n },\\n \\"groupRole\\": {\\n \\"sourceId\\": 35268,\\n \\"sourceType\\": \\"Namespace\\",\\n \\"accessLevel\\": 40,\\n \\"cnRoleName\\": \\"管理员\\",\\n \\"enRoleName\\": \\"Admin\\"\\n }\\n }\\n ],\\n \\"repositoryInfos\\": [\\n {\\n \\"repositoryInfo\\": {\\n \\"id\\": 37229,\\n \\"name\\": \\"test-repo\\",\\n \\"path\\": \\"test-repo\\",\\n \\"description\\": \\"具体的描述内容\\",\\n \\"nameWithNamespace\\": \\"test-org / test-group / test-repo（斜杠两侧有空格）\\",\\n \\"pathWithNamespace\\": \\"test-org/test-group/test-repo\\",\\n \\"visibilityLevel\\": 0,\\n \\"lastActivityAt\\": \\"2022-01-14T21:08:26+08:00\\\\n\\",\\n \\"namespaceId\\": 600002,\\n \\"accessLevel\\": 40,\\n \\"createdAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"updatedAt\\": \\"2022-01-14T21:08:26+08:00\\",\\n \\"archived\\": false,\\n \\"creatorId\\": 12679,\\n \\"encrypted\\": false\\n },\\n \\"repositoryRole\\": {\\n \\"sourceId\\": 37229,\\n \\"sourceType\\": \\"Project\\",\\n \\"accessLevel\\": 40,\\n \\"cnRoleName\\": \\"管理员\\",\\n \\"enRoleName\\": \\"Admin\\"\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取用户有权限的资源', + ], + 'CreateOAuthToken' => [ + 'summary' => '创建OAuthToken（此接口内测中，暂不支持使用）。', + 'path' => '/login/oauth/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'clientId' => [ + 'title' => 'clientId'."\n", + 'description' => 'clientId'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dc7e0b3c00a3e58f46', + ], + 'clientSecret' => [ + 'title' => 'client_secret', + 'description' => 'client_secret', + 'type' => 'string', + 'required' => true, + 'example' => 'a433294edea39cae7e7870', + ], + 'grantType' => [ + 'title' => '授权类型：code，token', + 'description' => '授权类型：code，token', + 'type' => 'string', + 'required' => true, + 'example' => 'code', + ], + 'scope' => [ + 'title' => '授权范围.例如：read:repo,write:repo', + 'description' => '授权范围'."\n" + ."\n" + .'例如：'."\n" + .'- 用户相关： read:user'."\n" + .'- 代码库相关：read:repo，write:repo'."\n" + .'- 代码库合并请求相关：repo:cr，read:repo:cr，write:repo:cr'."\n" + .'- 代码库分支相关：repo:branch，read:repo:branch，write:repo:branch'."\n" + ."\n" + .'><notice>更多的授权可通过地址'."\n" + .'https://account-devops.aliyun.com/settings/personalAccessToken 查看></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'read:repo', + ], + 'code' => [ + 'title' => '当前grantType=code时必传', + 'description' => '授权码，当前grantType=code时必传', + 'type' => 'string', + 'required' => false, + 'example' => '86df532f74454e189740d100ac97f4b9', + ], + 'login' => [ + 'title' => 'code = token时必传', + 'description' => '用户的登录账号，code = token时必传', + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'errorMessage' => [ + 'title' => 'Id of the request', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C2F153F6-BB43-50C4-9F4F-40593203E19A', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'accessToken' => [ + 'description' => '访问令牌', + 'type' => 'string', + 'example' => '2aeb4cd012af879e54f0d37dfa526f51', + ], + 'scope' => [ + 'description' => '授权范围', + 'type' => 'string', + 'example' => 'read:repo', + ], + 'tokenType' => [ + 'description' => 'token类型，固定值：bearer', + 'type' => 'string', + 'example' => 'bearer', + ], + 'id' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '30815', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"errorMessage\\": \\"”“\\",\\n \\"requestId\\": \\"C2F153F6-BB43-50C4-9F4F-40593203E19A\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": \\"true\\",\\n \\"result\\": {\\n \\"accessToken\\": \\"2aeb4cd012af879e54f0d37dfa526f51\\",\\n \\"scope\\": \\"read:repo\\",\\n \\"tokenType\\": \\"bearer\\",\\n \\"id\\": \\"30815\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOAuthTokenResponse>\\n <errorMessage>”“</errorMessage>\\n <requestId>C2F153F6-BB43-50C4-9F4F-40593203E19A</requestId>\\n <errorCode>Openapi.RequestError</errorCode>\\n <success>true</success>\\n <result>\\n <accessToken>2aeb4cd012af879e54f0d37dfa526f51</accessToken>\\n <scope>repo:read</scope>\\n <tokenType>code</tokenType>\\n <id>30815</id>\\n </result>\\n</CreateOAuthTokenResponse>","errorExample":""}]', + 'title' => '创建OAuthToken', + ], + 'CreateServiceConnection' => [ + 'summary' => '创建服务连接。', + 'path' => '/organization/{organizationId}/createServiceConnection', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURErdcCL5BE0', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'connectionType' => [ + 'title' => '连接类型', + 'description' => '服务连接类型', + 'type' => 'string', + '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' => '服务连接名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs连接', + ], + 'serviceAuthId' => [ + 'title' => '', + 'description' => '服务授权id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + 'scope' => [ + 'title' => '可见范围：如PERSON，GLOBAL，CUSTOM', + 'description' => '可见范围：如PERSON，GLOBAL，CUSTOM', + 'type' => 'string', + 'required' => true, + 'example' => 'PERSON （私有）'."\n" + .'GLOBAL （公开）'."\n" + .'CUSTOM （自定义）', + 'enum' => [ + 'PERSONAL', + 'GLOBAL', + 'CUSTOM', + ], + ], + 'authType' => [ + 'description' => '服务授权类型', + 'type' => 'string', + 'required' => true, + 'example' => 'CREDENTIAL （服务证书）'."\n" + .'AUTHENTICATION （服务授权）', + 'enum' => [ + 'CREDENTIAL', + 'AUTHENTICATION', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + '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' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'id' => [ + 'description' => '服务连接id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19224', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"id\\": 19224\\n}","type":"json"}]', + 'title' => '创建服务连接', + ], + 'CreateServiceAuth' => [ + 'summary' => '创建服务授权', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'serviceAuthType', + 'in' => 'query', + 'schema' => [ + 'title' => '授权类型，目前只支持RAM', + 'description' => '服务授权类型，目前只支持RAM', + 'type' => 'string', + 'required' => true, + 'example' => 'RAM （阿里云RAM类型）', + 'enum' => [ + 'RAM', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + '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' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'id' => [ + 'description' => '服务授权id', + 'type' => 'string', + 'example' => '1223', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"id\\": \\"1223\\"\\n}","type":"json"}]', + 'title' => '创建服务授权', + ], + 'CreateServiceCredential' => [ + 'summary' => '创建用户名密码类型的证书', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '证书名称', + 'description' => '服务证书名称', + 'type' => 'string', + 'required' => true, + 'example' => '张三的Git证书', + 'maxLength' => 100, + ], + 'type' => [ + 'title' => '证书类型，默认USERNAME_PASSWORD', + 'description' => '服务证书类型，默认USERNAME_PASSWORD', + 'type' => 'string', + 'required' => true, + 'example' => 'USERNAME_PASSWORD （用户密码类型）', + 'default' => 'USERNAME_PASSWORD', + 'enum' => [ + 'USERNAME_PASSWORD', + ], + ], + 'scope' => [ + 'title' => '可见范围：如PERSON', + 'description' => '可见范围：如PERSON', + 'type' => 'string', + 'required' => false, + 'example' => 'PERSON （私有）', + 'default' => 'PERSON', + 'enum' => [ + 'PERSON', + ], + ], + 'username' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'required' => true, + 'example' => 'zhangsan', + ], + 'password' => [ + 'title' => '密码', + 'description' => '密码', + 'type' => 'string', + 'required' => true, + 'example' => 'zhangsan', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'id' => [ + 'description' => '服务证书id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11222', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"id\\": 11222\\n}","type":"json"}]', + 'title' => '创建服务证书', + ], + 'ListServiceCredentials' => [ + 'summary' => '获取服务证书列表', + 'path' => '/organization/{organizationId}/serviceCredentials', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'serviceCredentials' => [ + 'description' => '服务证书列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '服务证书id', + 'description' => '服务证书id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ownerName' => [ + 'title' => '服务证书名称', + 'description' => '服务证书名称', + 'type' => 'string', + 'example' => '张三', + ], + 'type' => [ + 'title' => '服务证书类型', + 'description' => '服务证书类型', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'ownerStaffId' => [ + 'title' => '授权用户的 StaffId', + 'description' => '授权用户的 StaffId', + 'type' => 'string', + 'example' => '123456789', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceCredentials\\": [\\n {\\n \\"id\\": 123,\\n \\"ownerName\\": \\"张三\\",\\n \\"type\\": \\"Codeup\\",\\n \\"ownerStaffId\\": \\"123456789\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取服务证书列表', + ], + 'ListServiceAuths' => [ + 'summary' => '获取服务授权列表', + 'path' => '/organization/{organizationId}/serviceAuths', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'serviceAuthType', + 'in' => 'query', + 'schema' => [ + 'description' => '服务授权类型', + 'type' => 'string', + 'required' => true, + 'example' => 'RAM （阿里云RAM类型）', + 'enum' => [ + 'RAM', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + 'default' => '默认值', + ], + 'serviceAuths' => [ + 'title' => '服务授权', + 'description' => '服务授权列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '服务授权id', + 'description' => '服务授权id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ownerName' => [ + 'title' => '服务授权名称', + 'description' => '服务授权名称', + 'type' => 'string', + 'example' => '张三', + ], + 'type' => [ + 'title' => '服务授权类型', + 'description' => '服务授权类型', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'ownerStaffId' => [ + 'title' => '授权用户的 StaffId', + 'description' => '授权用户的 StaffId', + 'type' => 'string', + 'example' => '123456789', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceAuths\\": [\\n {\\n \\"id\\": 123,\\n \\"ownerName\\": \\"张三\\",\\n \\"type\\": \\"Codeup\\",\\n \\"ownerStaffId\\": \\"123456789\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取服务授权列表', + ], + 'ListServiceConnections' => [ + 'summary' => '可以获取服务连接列表。', + 'path' => '/organization/{organizationId}/serviceConnections', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'sericeConnectionType', + 'in' => 'query', + 'schema' => [ + 'title' => 'aliyun_code 阿里云代码 Codeup Codeup Gitee 码云 github Github ack 容器服务Kubernetes(ACK) docker_register_aliyun 容器镜像服务(ACR) ecs 对象存储(OSS) edas 企业级分布式应用(EDAS) emas 移动研发平台(EMAS) fc 阿里云函数计算(FC) kubernetes 自建k8s集群 oss 对象存储(OSS) PACKAGES 制品仓库 ros 资源编排服务(ROS) sae Serverless应用引擎(SAE)', + 'description' => '服务连接类型'."\n" + ."\n" + .'- aliyun_code 阿里云代码'."\n" + ."\n" + .'- Codeup Codeup'."\n" + ."\n" + .'- Gitee 码云'."\n" + ."\n" + .'- github Github '."\n" + ."\n" + .'- ack 容器服务Kubernetes（ACK）'."\n" + ."\n" + .'- docker_register_aliyun 容器镜像服务（ACR）'."\n" + ."\n" + .' - ecs ecs主机'."\n" + ."\n" + .'- edas 企业级分布式应用（EDAS） '."\n" + ."\n" + .'- emas 移动研发平台（EMAS）'."\n" + ."\n" + .'- fc 阿里云函数计算（FC）'."\n" + ."\n" + .'- kubernetes 自建k8s集群'."\n" + ."\n" + .'- oss 对象存储（OSS）'."\n" + ."\n" + .'- PACKAGES 制品仓库'."\n" + ."\n" + .'- ros 资源编排服务（ROS）'."\n" + ."\n" + .'- sae Serverless应用引擎（SAE）', + 'type' => 'string', + 'required' => true, + 'example' => 'codeup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'serviceConnections' => [ + 'title' => '服务连接', + 'description' => '服务连接', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ownerAccountId' => [ + 'title' => '拥有者阿里云账号id', + 'description' => '拥有者阿里云账号id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212123212121212', + ], + 'name' => [ + 'title' => '服务连接名称', + 'description' => '服务连接名称', + 'type' => 'string', + 'example' => '张三的oss服务连接', + ], + 'id' => [ + 'title' => '服务连接Id', + 'description' => '服务连接Id', + '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', + 'description' => 'uuid', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"serviceConnections\\": [\\n {\\n \\"ownerAccountId\\": 1212123212121212,\\n \\"name\\": \\"张三的oss服务连接\\",\\n \\"id\\": 123,\\n \\"type\\": \\"oss\\",\\n \\"createTime\\": 1586863220000,\\n \\"uuid\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceConnectionsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <serviceConnections>\\n <ownerAccountId>1212123212121212</ownerAccountId>\\n <name>张三的oss服务连接</name>\\n <id>123</id>\\n <type>oss</type>\\n <createTime>1586863220000</createTime>\\n </serviceConnections>\\n</ListServiceConnectionsResponse>","errorExample":""}]', + 'title' => '获取服务连接列表', + ], + 'StopVMDeployOrder' => [ + 'summary' => '可以终止机器部署。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '终止机器部署', + ], + 'SkipVMDeployMachine' => [ + 'summary' => '可以跳过机器部署。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/skip', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '机器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' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '跳过机器部署', + ], + 'RetryVMDeployMachine' => [ + 'summary' => '可以重试机器部署。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/retry', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '机器SN', + 'type' => 'string', + 'required' => true, + 'example' => 'assssssss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '重试机器部署', + ], + 'ResumeVMDeployOrder' => [ + 'summary' => '可以继续部署单运行。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/resume', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '继续部署单运行', + ], + 'GetVMDeployOrder' => [ + 'summary' => '可以获取部署单详情。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1222', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'deployOrder' => [ + 'title' => '部署单', + 'description' => '部署单', + 'type' => 'object', + 'properties' => [ + 'deployOrderId' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + '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' => '发布状态'."\n" + .' '."\n" + .'- Waiting（暂停）'."\n" + ."\n" + .'- Running（部署中） '."\n" + ."\n" + .'- Cancelled（已取消）'."\n" + ."\n" + .'- Success（成功）', + 'type' => 'string', + 'example' => 'Success', + ], + 'exceptionCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '错误信息', + ], + 'deployMachineInfo' => [ + 'title' => '部署机器信息', + 'description' => '部署机器信息', + 'type' => 'object', + 'properties' => [ + 'hostGroupId' => [ + 'title' => '主机组ID', + 'description' => '主机组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'batchNum' => [ + 'title' => '发布批次', + 'description' => '发布批次', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'deployMachines' => [ + 'title' => '部署机器列表', + 'description' => '部署机器列表', + 'type' => 'array', + 'items' => [ + 'description' => '部署机器', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111', + ], + 'status' => [ + 'title' => '部署状态', + 'description' => '- Success(成功)'."\n" + ."\n" + .'- Pending（待部署） '."\n" + ."\n" + .'- Running（部署中）'."\n" + ."\n" + .'- Cancelled（取消）'."\n" + ."\n" + .'- Queued(部署等待中)'."\n" + ."\n" + .'- Failed（失败）'."\n" + ."\n" + .'- Skipped（已跳过）', + 'type' => 'string', + 'example' => 'Success', + ], + 'machineSn' => [ + 'title' => '机器sn', + 'description' => '机器sn', + 'type' => 'string', + 'example' => 'sasssasa', + ], + 'clientStatus' => [ + 'title' => '机器状态', + 'description' => 'ok(正常) error(连接失败)', + 'type' => 'string', + 'example' => 'ok', + ], + 'ip' => [ + 'title' => '机器IP', + 'description' => '机器IP', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'actions' => [ + 'title' => '后续action', + 'description' => '后续action', + 'type' => 'array', + 'items' => [ + 'description' => '后续可以执行的action', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'Action', + 'description' => '- RetryVMDeployMachine 重试机器部署'."\n" + .'- SkipVMDeployMachine 跳过机器部署'."\n" + .'- LogVMDeployMachine 查看机器部署日志', + 'type' => 'string', + 'example' => 'RetryVMDeployMachine', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '当前用户是否有权限进行后续action', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'title' => '参数', + 'description' => '参数', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + 'batchNum' => [ + 'title' => '部署批次', + 'description' => '部署批次', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + ], + ], + ], + ], + ], + 'actions' => [ + 'title' => '后续action', + 'description' => '后续action', + 'type' => 'array', + 'items' => [ + 'description' => '后续可以进行的Action', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'Action', + 'description' => 'StopVMDeployOrder 取消部署单'."\n" + .'ResumeVMDeployOrder 继续部署单运行', + 'type' => 'string', + 'example' => 'StopVMDeployOrder', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '当前用户是否有权限进行后续action', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'title' => '参数', + 'description' => '参数', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"deployOrder\\": {\\n \\"deployOrderId\\": \\"11111\\",\\n \\"createTime\\": 111111111111,\\n \\"updateTime\\": 11111111111,\\n \\"creator\\": \\"ssaassa\\",\\n \\"currentBatch\\": 2,\\n \\"totalBatch\\": 3,\\n \\"status\\": \\"Success\\",\\n \\"exceptionCode\\": \\"错误信息\\",\\n \\"deployMachineInfo\\": {\\n \\"hostGroupId\\": 1111,\\n \\"batchNum\\": 11,\\n \\"deployMachines\\": [\\n {\\n \\"createTime\\": 1111111111,\\n \\"updateTime\\": 11111111,\\n \\"status\\": \\"Success\\",\\n \\"machineSn\\": \\"sasssasa\\",\\n \\"clientStatus\\": \\"ok\\",\\n \\"ip\\": \\"127.0.0.1\\",\\n \\"actions\\": [\\n {\\n \\"type\\": \\"RetryVMDeployMachine\\",\\n \\"disable\\": true,\\n \\"params\\": {}\\n }\\n ],\\n \\"batchNum\\": 22\\n }\\n ]\\n },\\n \\"actions\\": [\\n {\\n \\"type\\": \\"StopVMDeployOrder\\",\\n \\"disable\\": true,\\n \\"params\\": {}\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVMDeployOrderResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <success>false</success>\\n <errorCode>”“</errorCode>\\n <deployOrder>\\n <deployOrderId>11111</deployOrderId>\\n <createTime>111111111111</createTime>\\n <updateTime>11111111111</updateTime>\\n <creator>ssaassa</creator>\\n <currentBatch>2</currentBatch>\\n <totalBatch>3</totalBatch>\\n <status>Success</status>\\n <exceptionCode>错误信息</exceptionCode>\\n <deployMachineInfo>\\n <hostGroupId>1111</hostGroupId>\\n <batchNum>11</batchNum>\\n <deployMachines>\\n <createTime>1111111111</createTime>\\n <updateTime>11111111</updateTime>\\n <status>Success</status>\\n <machineSn>sasssasa</machineSn>\\n <clientStatus>ok</clientStatus>\\n <ip>127.0.0.1</ip>\\n <actions>\\n <type>RetryVMDeployMachine</type>\\n <disable>true</disable>\\n </actions>\\n <batchNum>22</batchNum>\\n </deployMachines>\\n </deployMachineInfo>\\n <actions>\\n <type>StopVMDeployOrder</type>\\n <disable>true</disable>\\n </actions>\\n </deployOrder>\\n</GetVMDeployOrderResponse>","errorExample":""}]', + 'title' => '获取部署单详情', + ], + 'LogVMDeployMachine' => [ + 'summary' => '可以查询机器部署日志。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/log', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'deployOrderId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署单ID', + 'description' => '部署单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'machineSn', + 'in' => 'path', + 'schema' => [ + 'title' => '机器SN', + 'description' => '机器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' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + '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' => '1719312026', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"deployMachineLog\\": {\\n \\"deployLog\\": \\"success\\",\\n \\"aliyunRegion\\": \\"cn-hangzhou\\",\\n \\"deployLogPath\\": \\"/tmp/log\\",\\n \\"deployBeginTime\\": 11111111111,\\n \\"deployEndTime\\": 1719312026\\n }\\n}","type":"json"}]', + 'title' => '查询机器部署日志', + ], + 'CreatePipelineGroup' => [ + 'summary' => '创建流水线分组。', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线分组名，企业唯一', + 'type' => 'string', + 'required' => true, + 'example' => '流水线分组名称', + 'maxLength' => 40, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineGroup' => [ + 'description' => '流水线分组', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '流水线分组名称', + 'type' => 'string', + 'example' => '流水线分组名称', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroup\\": {\\n \\"id\\": 111,\\n \\"name\\": \\"流水线分组名称\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreatePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <pipelineGroup>\\n <id>111</id>\\n <name>流水线分组名称</name>\\n </pipelineGroup>\\n</CreatePipelineGroupResponse>","errorExample":""}]', + 'title' => '创建流水线分组', + ], + 'DeletePipelineGroup' => [ + 'summary' => '删除流水线分组。', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线分组Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>“”</errorCode>\\n</DeletePipelineGroupResponse>","errorExample":""}]', + 'title' => '删除流水线分组', + ], + 'JoinPipelineGroup' => [ + 'summary' => '将流水线加入流水线分组。', + 'path' => '/organization/{organizationId}/pipelineGroups/join', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineIds', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线Id，多个逗号分割', + 'type' => 'string', + 'required' => true, + 'example' => '122,122', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线分组id ,0 表示将流水线改为未分组', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '将流水线加入流水线分组', + ], + 'UpdatePipelineGroup' => [ + 'summary' => '更新流水线分组。', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线分组名称', + 'type' => 'string', + 'required' => true, + 'example' => '流水线分组名称', + 'maxLength' => 40, + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdatePipelineGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</UpdatePipelineGroupResponse>","errorExample":""}]', + 'title' => '更新流水线分组', + ], + 'GetPipelineGroup' => [ + 'summary' => '获取流水线分组。', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线分组id，0表示未分组', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineGroup' => [ + 'description' => '流水线分组', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'id' => [ + 'description' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '流水线分组名称', + 'type' => 'string', + 'example' => '流水线分组名称', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroup\\": {\\n \\"createTime\\": 1586863220000,\\n \\"id\\": 111,\\n \\"name\\": \\"流水线分组名称\\"\\n }\\n}","type":"json"}]', + 'title' => '获取流水线分组', + ], + 'ListPipelineGroupPipelines' => [ + 'summary' => '获取流水线分组下流水线列表。', + 'path' => '/organization/{organizationId}/pipelineGroups/{groupId}/pipelines', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。最大支持50', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaa', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => false, + 'example' => '流水线', + ], + ], + [ + 'name' => 'executeStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线最后执行开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线最后执行结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线创建开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'resultStatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线最后运行状态，多个逗号分割，SUCCESS 运行成功, RUNNING 运行中,FAIL 运行失败,CANCELED 已取消,WAITING等待中', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING,SUCCESS', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线创建结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + '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' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '分页token,为空表示没有下一页', + 'type' => 'string', + 'example' => 'aaaa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"流水线名称\\",\\n \\"createTime\\": 1586863220000,\\n \\"pipelineId\\": 1111\\n }\\n ],\\n \\"totalCount\\": 20,\\n \\"nextToken\\": \\"aaaa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPipelineGroupPipelinesResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <pipelines>\\n <pipelineName>流水线名称</pipelineName>\\n <createTime>1586863220000</createTime>\\n <pipelineId>1111</pipelineId>\\n </pipelines>\\n <totalCount>20</totalCount>\\n <nextToken>aaaa</nextToken>\\n</ListPipelineGroupPipelinesResponse>","errorExample":""}]', + 'title' => '获取流水线分组下流水线列表', + ], + 'ListPipelineGroups' => [ + 'summary' => '获取流水线分组列表。', + 'path' => '/organization/{organizationId}/pipelineGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回值，最大值50', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaaaaaaaa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败'."\n" + ."\n", + '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' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'nextToken' => [ + 'description' => '分页token，为空表示没有下一页', + 'type' => 'string', + 'example' => 'ssaassasass', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineGroups\\": [\\n {\\n \\"name\\": \\"流水线分组名称\\",\\n \\"id\\": 111,\\n \\"createTime\\": 1586863220000\\n }\\n ],\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"ssaassasass\\"\\n}","type":"json"}]', + 'title' => '获取流水线分组列表', + ], + 'CreateFlowTag' => [ + 'summary' => '创建标签。', + 'path' => '/organization/{organizationId}/flow/tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称，最大长度20', + 'type' => 'string', + 'required' => true, + 'example' => '标签名称', + 'maxLength' => 20, + ], + ], + [ + 'name' => 'color', + 'in' => 'query', + 'schema' => [ + 'description' => '- \\#1F9AEF蓝色'."\n" + ."\n" + .'- \\#E63A3A红色'."\n" + ."\n" + .'- \\#FA8C15 黄色'."\n" + ."\n" + .'- \\#15AD31 绿色'."\n" + ."\n" + .'- \\#7978E5 紫色'."\n" + ."\n" + .'- \\#8C8C8C 灰色', + 'type' => 'string', + 'required' => true, + 'example' => '#1F9AEF', + 'enum' => [ + '#1F9AEF', + '#E63A3A', + '#FA8C15', + '#15AD31', + '#7978E5', + '#8C8C8C', + ], + ], + ], + [ + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签分类id，0表示未分类', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'id' => [ + 'description' => '标签id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 111\\n}","type":"json"}]', + 'title' => '创建标签', + ], + 'CreateFlowTagGroup' => [ + 'summary' => '创建标签分类。', + 'path' => '/organization/{organizationId}/flow/tagGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '标签分类名称，不能重复，最多20个字符', + 'type' => 'string', + 'required' => true, + 'example' => '标签分类名称', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'id' => [ + 'title' => '标签分类', + 'description' => '标签分类id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1223', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"id\\": 1223\\n}","type":"json"}]', + 'title' => '创建标签分类', + ], + 'DeleteFlowTagGroup' => [ + 'summary' => '删除标签分类。', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '标签分类id', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '删除标签分类', + ], + 'DeleteFlowTag' => [ + 'summary' => '删除标签。', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '标签id', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFlowTagResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <success>false</success>\\n <errorCode>”“</errorCode>\\n</DeleteFlowTagResponse>","errorExample":""}]', + 'title' => '删除标签', + 'description' => '用户具有所有标签管理权限可以删除所有标签或者只能删除自己创建的标签', + ], + 'UpdateFlowTag' => [ + 'summary' => '更新标签。', + 'path' => '/organization/{organizationId}/flow/tags/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '标签id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'color', + 'in' => 'query', + 'schema' => [ + 'description' => '- \\#1F9AEF蓝色'."\n" + ."\n" + .'- \\#E63A3A红色'."\n" + ."\n" + .'- \\#FA8C15 黄色'."\n" + ."\n" + .'- \\#15AD31 绿色'."\n" + ."\n" + .'- \\#7978E5 紫色'."\n" + ."\n" + .'- \\#8C8C8C 灰色', + 'type' => 'string', + 'required' => true, + 'example' => '#1F9AEF', + 'enum' => [ + '#1F9AEF', + '#E63A3A', + '#FA8C15', + '#15AD31', + '#7978E5', + '#8C8C8C', + ], + ], + ], + [ + 'name' => 'flowTagGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签分类id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + 'type' => 'string', + 'required' => true, + 'example' => '标签名称', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '更新标签', + ], + 'UpdateFlowTagGroup' => [ + 'summary' => '更新标签分类。', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '标签分类id', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '标签分类名称', + 'type' => 'string', + 'required' => true, + 'example' => '标签分类名称', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '更新标签分类', + ], + 'GetFlowTagGroup' => [ + 'summary' => '获取标签分类。', + 'path' => '/organization/{organizationId}/flow/tagGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '标签分类Id', + 'type' => 'string', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'flowTagGroup' => [ + 'description' => '标签分类', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '标签分类id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'name' => [ + 'description' => '标签分类名称', + 'type' => 'string', + 'example' => '标签分类名称', + ], + 'creatorAccountId' => [ + 'description' => '创建人', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'modiferAccountId' => [ + 'description' => '更新人', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'flowTagList' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '标签id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => '标签名称', + ], + 'color' => [ + 'description' => '标签颜色', + 'type' => 'string', + 'example' => '#1F9AEF', + ], + 'creatorAccountId' => [ + 'description' => '创建人', + 'type' => 'string', + 'example' => '1111111111111', + ], + 'modiferAccountId' => [ + 'description' => '更新人', + 'type' => 'string', + 'example' => '1111111111111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"flowTagGroup\\": {\\n \\"id\\": 1111,\\n \\"name\\": \\"标签分类名称\\",\\n \\"creatorAccountId\\": \\"1111111111111\\",\\n \\"modiferAccountId\\": \\"1111111111111\\",\\n \\"flowTagList\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"标签名称\\",\\n \\"color\\": \\"#1F9AEF\\",\\n \\"creatorAccountId\\": \\"1111111111111\\",\\n \\"modiferAccountId\\": \\"1111111111111\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取标签分类', + ], + 'ListFlowTagGroups' => [ + 'summary' => '获取流水线分类列表。', + 'path' => '/organization/{organizationId}/flow/tagGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如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，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + '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' => '标签分类id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'name' => [ + 'title' => '标签分类名称', + 'description' => '标签分类名称', + 'type' => 'string', + 'example' => '标签名称', + ], + 'creatorAccountId' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'string', + 'example' => '111111111', + ], + 'modiferAccountId' => [ + 'title' => '修改人', + 'description' => '修改人', + 'type' => 'string', + 'example' => '11111111', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"flowTagGroups\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"标签名称\\",\\n \\"creatorAccountId\\": \\"111111111\\",\\n \\"modiferAccountId\\": \\"11111111\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取流水线分类列表', + ], + 'CreateSshKey' => [ + 'summary' => '可以创建企业公钥。', + 'path' => '/organization/{organizationId}/sshKey', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sshKey' => [ + 'title' => '企业公钥', + 'description' => '企业公钥', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'title' => '企业公钥', + 'description' => '企业公钥', + 'type' => 'string', + 'example' => 'assssssssssss', + ], + 'id' => [ + 'title' => '企业公钥id', + 'description' => '企业公钥id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"assssssssssss\\",\\n \\"id\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSshKeyResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <sshKey>\\n <publicKey>assssssssssss</publicKey>\\n <id>123</id>\\n </sshKey>\\n</CreateSshKeyResponse>","errorExample":""}]', + 'title' => '创建企业公钥', + ], + 'ResetSshKey' => [ + 'summary' => '可以重置企业公钥。', + 'path' => '/organization/{organizationId}/sshKey', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sshKey' => [ + 'title' => '企业公钥', + 'description' => '企业公钥', + 'type' => 'object', + 'properties' => [ + 'publicKey' => [ + 'title' => '企业公钥', + 'description' => '企业公钥', + 'type' => 'string', + 'example' => 'saaaaaaaaaaaaaaaa', + ], + 'id' => [ + 'title' => '企业公钥id', + 'description' => '企业公钥id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"sshKey\\": {\\n \\"publicKey\\": \\"saaaaaaaaaaaaaaaa\\",\\n \\"id\\": 1212\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResetSshKeyResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <sshKey>\\n <publicKey>saaaaaaaaaaaaaaaa</publicKey>\\n <id>1212</id>\\n </sshKey>\\n</ResetSshKeyResponse>","errorExample":""}]', + 'title' => '重置企业公钥', + ], + 'CreateResourceMember' => [ + 'summary' => '可以插入资源成员。', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源id', + 'description' => '资源类型pipeline 流水线hostGroup主机组', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'accountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户id', + 'description' => '阿里云账号id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1111111111111', + ], + ], + [ + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => [ + 'title' => '角色部署组 deployGroup user 成员，使用权限 admin 管理员，使用编辑权限 流水线 pipeline admin 查看、运行、编辑权限 member 运行权限 viewer 查看权限', + 'description' => '角色部署组 hostGroup '."\n" + ."\n" + .'- user 成员，使用权限 '."\n" + ."\n" + .'- admin 管理员，使用编辑权限'."\n" + ."\n" + .'- owner 拥有者，所有权限 '."\n" + ."\n" + .'流水线 pipeline '."\n" + ."\n" + .'- owner 拥有者，所有权限'."\n" + ."\n" + .'- admin 查看、运行、编辑权限'."\n" + ."\n" + .'- member 运行权限 '."\n" + ."\n" + .'- viewer 查看权限', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型 流水线 pipeline 部署组 deployGroup', + 'description' => '资源id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</CreateResourceMemberResponse>","errorExample":""}]', + 'title' => '插入资源成员', + ], + 'DeleteResourceMember' => [ + 'summary' => '可以删除资源成员。', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源id', + 'description' => '- 资源类型'."\n" + ."\n" + .' pipeline 流水线'."\n" + ."\n" + .' hostGroup 部署组', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型流水线 pipeline 部署组 deployGroup', + 'description' => '资源Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号id', + 'type' => 'string', + 'required' => true, + 'example' => '2211221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeleteResourceMemberResponse>","errorExample":""}]', + 'title' => '删除资源成员', + ], + 'UpdateResourceMember' => [ + 'summary' => '可以更新资源成员。', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members/{accountId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源Id', + 'description' => '资源类型 pipeline 流水线 hostGroup 主机组', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999999999', + 'minimum' => '1', + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'roleName', + 'in' => 'formData', + 'schema' => [ + 'title' => '角色部署组 deployGroup user 成员，使用权限 admin 管理员，使用编辑权限 owner 拥有者，所有权限 流水线 pipeline owner 拥有者，所有权限 admin 查看、运行、编辑权限 member 运行权限 viewer 查看权限', + 'description' => '角色部署组 hostGroup '."\n" + ."\n" + .'- user 成员，使用权限 '."\n" + ."\n" + .'- admin 管理员，使用编辑权限'."\n" + ."\n" + .'- owner 拥有者，所有权限 '."\n" + ."\n" + .'流水线 pipeline '."\n" + ."\n" + .'- owner 拥有者，所有权限'."\n" + ."\n" + .'- admin 查看、运行、编辑权限'."\n" + ."\n" + .'- member 运行权限 '."\n" + ."\n" + .'- viewer 查看权限', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型 流水线 pipeline 部署组 deployGroup', + 'description' => '资源id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号id', + 'type' => 'string', + 'required' => false, + 'example' => '11111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateResourceMemberResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</UpdateResourceMemberResponse>","errorExample":""}]', + 'title' => '更新资源成员', + ], + 'ListResourceMembers' => [ + 'summary' => '可以获取资源成员列表。', + 'path' => '/organization/{organizationId}/{resourceType}/{resourceId}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'title' => '资源类型流水线 pipeline 部署组 deployGroup', + 'description' => '资源类型pipeline流水线 hostGroup主机组', + 'type' => 'string', + 'required' => true, + 'example' => 'pipeline', + 'enum' => [ + 'pipeline', + 'hostGroup', + ], + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => 'true 成功 false 失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'resourceMembers' => [ + 'title' => '成员', + 'description' => '成员', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '账号id', + 'description' => '账号id', + 'type' => 'string', + 'example' => '22212212', + ], + 'roleName' => [ + 'title' => '角色', + 'description' => '角色部署组 hostGroup '."\n" + ."\n" + .'- user 成员，使用权限 '."\n" + ."\n" + .'- admin 管理员，使用编辑权限'."\n" + ."\n" + .'- owner 拥有者，所有权限 '."\n" + ."\n" + .'流水线 pipeline '."\n" + ."\n" + .'- owner 拥有者，所有权限'."\n" + ."\n" + .'- admin 查看、运行、编辑权限'."\n" + ."\n" + .'- member 运行权限 '."\n" + ."\n" + .'- viewer 查看权限', + 'type' => 'string', + 'example' => 'admin', + ], + 'username' => [ + 'title' => '用户名称', + 'description' => '用户名称', + 'type' => 'string', + 'example' => '张三', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"resourceMembers\\": [\\n {\\n \\"accountId\\": \\"22212212\\",\\n \\"roleName\\": \\"admin\\",\\n \\"username\\": \\"张三\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceMembersResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <resourceMembers>\\n <accountId>22212212</accountId>\\n <roleName>admin</roleName>\\n <username>张三</username>\\n </resourceMembers>\\n</ListResourceMembersResponse>","errorExample":""}]', + 'title' => '获取资源成员列表', + ], + 'CreateHostGroup' => [ + 'summary' => '可以创建主机组。', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => '主机组类型，暂只支持ECS', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + 'enum' => [ + 'ECS', + ], + ], + ], + [ + 'name' => 'envId', + 'in' => 'formData', + 'schema' => [ + 'description' => '环境id', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '主机组名称', + 'type' => 'string', + 'required' => true, + 'example' => '主机组', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务连接id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '标签id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '12,234', + ], + ], + [ + 'name' => 'ecsType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ECS类型，暂支持ECS_ALIYUN', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_ALIYUN', + 'enum' => [ + 'ECS_ALIYUN', + ], + ], + ], + [ + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ecs标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ecs标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => [ + 'description' => '阿里云region', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => [ + 'description' => 'aliyunRegionId 机器所在aliyun region，machineSn 机器的sn, instanceName,主机名，ip主机ip', + 'type' => 'string', + 'required' => false, + 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true,调用成功，false调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroupId' => [ + 'description' => '主机组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroupId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<CreateHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroupId>123</hostGroupId>\\n</CreateHostGroupResponse>","errorExample":""}]', + 'title' => '创建主机组', + ], + 'DeleteHostGroup' => [ + 'summary' => '可以删除主机组。', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '部署组Id', + 'description' => '主机组Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11222', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeleteHostGroupResponse>","errorExample":""}]', + 'title' => '删除主机组', + ], + 'UpdateHostGroup' => [ + 'summary' => '可以更新主机组。', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURErdcI0DEJM', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => '暂只支持ECS', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + 'enum' => [ + 'ECS', + ], + ], + ], + [ + 'name' => 'envId', + 'in' => 'formData', + 'schema' => [ + 'description' => '环境id', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '主机组名称', + 'type' => 'string', + 'required' => true, + 'example' => '主机组', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务连接id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'tagIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '标签id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '12,23', + ], + ], + [ + 'name' => 'ecsType', + 'in' => 'formData', + 'schema' => [ + 'description' => '暂只支持ECS_ALIYUN', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_ALIYUN', + 'enum' => [ + 'ECS_ALIYUN', + ], + ], + ], + [ + 'name' => 'ecsLabelKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ecs标签Key', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ecsLabelValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ecs标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'aliyunRegion', + 'in' => 'formData', + 'schema' => [ + 'description' => '阿里云区域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'machineInfos', + 'in' => 'formData', + 'schema' => [ + 'description' => '机器信息，aliyunRegionId 机器所在aliyun region，machineSn 机器的sn, instanceName,主机名，ip主机ip', + 'type' => 'string', + 'required' => false, + 'example' => '[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.0.0.0"}]', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '主机组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' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true调用成功,false调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</UpdateHostGroupResponse>","errorExample":""}]', + 'title' => '更新主机组', + ], + 'GetHostGroup' => [ + 'summary' => '可以获取主机组。', + 'path' => '/organization/{organizationId}/hostGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '主机组id', + 'description' => '主机组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroup' => [ + 'description' => '主机组', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'description' => '创建者阿里云账号id', + 'type' => 'string', + 'example' => '111111', + ], + 'upateTIme' => [ + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'hostNum' => [ + 'description' => '主机数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'modifierAccountId' => [ + 'description' => '修改者阿里云账号id', + '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' => 'ecs类型，暂只支持ECS_ALIYUN', + 'type' => 'string', + 'example' => 'ECS_ALIYUN', + ], + 'aliyunRegion' => [ + 'description' => '阿里云区域', + 'type' => 'string', + 'example' => 'cn-bejing', + ], + 'ecsLabelKey' => [ + 'description' => 'ecs标签Key', + 'type' => 'string', + 'example' => 'ecs', + ], + 'id' => [ + 'description' => '主机组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'description' => '主机组名称', + 'type' => 'string', + 'example' => '主机组名称', + ], + 'serviceConnectionId' => [ + 'description' => '服务连接id', + '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' => '机器ip', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'objectType' => [ + 'description' => 'MachineInfo 值固定为 MachineInfo', + 'type' => 'string', + 'example' => 'MachineInfo', + ], + 'aliyunRegionId' => [ + 'description' => '阿里云区域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'machineSn' => [ + 'description' => '机器sn', + 'type' => 'string', + 'example' => '1ssasa', + ], + ], + ], + ], + 'ecsLabelValue' => [ + 'description' => 'ecs标签value', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroup\\": {\\n \\"creatorAccountId\\": \\"111111\\",\\n \\"upateTIme\\": 1586863220000,\\n \\"hostNum\\": 1,\\n \\"modifierAccountId\\": \\"11111\\",\\n \\"description\\": \\"主机组描述\\",\\n \\"type\\": \\"ECS\\",\\n \\"createTime\\": 1586863220000,\\n \\"ecsType\\": \\"ECS_ALIYUN\\",\\n \\"aliyunRegion\\": \\"cn-bejing\\",\\n \\"ecsLabelKey\\": \\"ecs\\",\\n \\"id\\": 1234,\\n \\"name\\": \\"主机组名称\\",\\n \\"serviceConnectionId\\": 1234,\\n \\"hostInfos\\": [\\n {\\n \\"updateTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"11111\\",\\n \\"instanceName\\": \\"ceshi\\",\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"ip\\": \\"127.0.0.1\\",\\n \\"createTime\\": 1586863220000,\\n \\"objectType\\": \\"MachineInfo\\",\\n \\"aliyunRegionId\\": \\"cn-hangzhou\\",\\n \\"machineSn\\": \\"1ssasa\\"\\n }\\n ],\\n \\"ecsLabelValue\\": \\"ecs\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHostGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroup>\\n <creatorAccountId>111111</creatorAccountId>\\n <upateTIme>1586863220000</upateTIme>\\n <hostNum>1</hostNum>\\n <modifierAccountId>11111</modifierAccountId>\\n <description>主机组描述</description>\\n <type>ECS</type>\\n <createTime>1586863220000</createTime>\\n <ecsType>ECS_ALIYUN</ecsType>\\n <aliyunRegion>cn-bejing</aliyunRegion>\\n <ecsLabelKey>ecs</ecsLabelKey>\\n <id>1234</id>\\n <name>主机组名称</name>\\n <serviceConnectionId>1234</serviceConnectionId>\\n <hostInfos>\\n <updateTime>1586863220000</updateTime>\\n <creatorAccountId>11111</creatorAccountId>\\n <instanceName>ceshi</instanceName>\\n <modifierAccountId>11111111111</modifierAccountId>\\n <ip>127.0.0.1</ip>\\n <createTime>1586863220000</createTime>\\n <objectType>MachineInfo</objectType>\\n <aliyunRegionId>cn-hangzhou</aliyunRegionId>\\n <machineSn>1ssasa</machineSn>\\n </hostInfos>\\n <ecsLabelValue>ecs</ecsLabelValue>\\n </hostGroup>\\n</GetHostGroupResponse>","errorExample":""}]', + 'title' => '获取主机组', + ], + 'ListHostGroups' => [ + 'summary' => '可以获取主机组列表。', + 'path' => '/organization/{organizationId}/hostGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'ids', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组id，多个逗号分割', + 'description' => '主机组id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '121,1212121232', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组创建时间', + 'description' => '主机组创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组结束时间', + 'description' => '主机组结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '主机组名称', + 'description' => '主机组名称', + 'type' => 'string', + 'required' => false, + 'example' => '主机组', + ], + ], + [ + 'name' => 'creatorAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '创建阿里云账号id，多个逗号分割', + 'description' => '创建阿里云账号id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '1112122121,3223332', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页token', + 'description' => '分页token', + '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' => '排序条件ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ID', + ], + ], + [ + 'name' => 'pageOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '排序顺序 DESC 降序 ASC升序', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'hostGroups' => [ + 'title' => '主机组', + 'description' => '主机组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '创建人阿里云账号id', + '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' => '修改人阿里云账号id', + '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' => 'ecs标签Key', + 'type' => 'string', + 'example' => 'ecs', + ], + 'name' => [ + 'title' => '部署组名称', + 'description' => '部署组名称', + 'type' => 'string', + 'example' => '部署组', + ], + 'id' => [ + 'title' => '323232', + 'description' => '部署组Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '444xxxx', + ], + 'serviceConnectionId' => [ + 'title' => '服务连接Id', + 'description' => '服务连接Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1212122', + ], + 'ecsLabelValue' => [ + 'title' => 'Ecs标签值', + 'description' => 'Ecs标签值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '分页token,空表示最后一页', + 'description' => '分页token,空表示最后一页', + 'type' => 'string', + 'example' => 'asassasassa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"hostGroups\\": [\\n {\\n \\"creatorAccountId\\": \\"2222222222222\\",\\n \\"updateTime\\": 1586863220000,\\n \\"hostNum\\": 3,\\n \\"modifierAccountId\\": \\"211111111\\",\\n \\"description\\": \\"主机组\\",\\n \\"type\\": \\"ECS\\",\\n \\"createTime\\": 1586863220000,\\n \\"ecsType\\": \\"ECS_ALIYUN\\",\\n \\"aliyunRegion\\": \\"cn-beijing\\",\\n \\"ecsLabelKey\\": \\"ecs\\",\\n \\"name\\": \\"部署组\\",\\n \\"id\\": 0,\\n \\"serviceConnectionId\\": 1212122,\\n \\"ecsLabelValue\\": \\"value\\"\\n }\\n ],\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"asassasassa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListHostGroupsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <hostGroups>\\n <creatorAccountId>2222222222222</creatorAccountId>\\n <updateTime>1586863220000</updateTime>\\n <hostNum>3</hostNum>\\n <modifierAccountId>211111111</modifierAccountId>\\n <description>主机组</description>\\n <type>ECS</type>\\n <createTime>1586863220000</createTime>\\n <ecsType>ECS_ALIYUN</ecsType>\\n <aliyunRegion>cn-beijing</aliyunRegion>\\n <ecsLabelKey>ecs</ecsLabelKey>\\n <name>部署组</name>\\n <serviceConnectionId>1212122</serviceConnectionId>\\n <ecsLabelValue>value</ecsLabelValue>\\n </hostGroups>\\n <totalCount>50</totalCount>\\n <nextToken>asassasassa</nextToken>\\n</ListHostGroupsResponse>","errorExample":""}]', + 'title' => '获取主机组列表', + ], + 'CreateVariableGroup' => [ + 'summary' => '可以创建变量组。', + 'path' => '/organization/{organizationId}/variableGroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组名称', + 'description' => '变量组名称', + 'type' => 'string', + 'required' => true, + 'example' => '变量组', + ], + ], + [ + 'name' => 'description', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组描述', + 'description' => '变量组描述', + 'type' => 'string', + 'required' => false, + 'example' => '变量组描述', + ], + ], + [ + 'name' => 'variables', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'description' => '变量信息JSON字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'type' => 'string', + 'required' => true, + 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroupId' => [ + 'title' => '新建的变量组id', + 'description' => '新建的变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"variableGroupId\\": 1234\\n}","errorExample":""},{"type":"xml","example":"<CreateVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n <variableGroupId>1234</variableGroupId>\\n</CreateVariableGroupResponse>","errorExample":""}]', + 'title' => '创建变量组', + ], + 'DeleteVariableGroup' => [ + 'summary' => '可以删除变量组。', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</DeleteVariableGroupResponse>","errorExample":""}]', + 'title' => '删除变量组', + ], + 'UpdateVariableGroup' => [ + 'summary' => '可以更新变量组。', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组名称', + 'description' => '变量组名称', + 'type' => 'string', + 'required' => true, + 'example' => '变量组', + ], + ], + [ + 'name' => 'description', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量组描述', + 'description' => '变量组描述', + 'type' => 'string', + 'required' => false, + 'example' => '变量组描述', + ], + ], + [ + 'name' => 'variables', + 'in' => 'formData', + 'schema' => [ + 'title' => '变量信息json字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'description' => '变量信息JSON字符串 isEncrypted 是否加密 name 变量名称 value 变量值', + 'type' => 'string', + 'required' => true, + 'example' => '[{"isEncrypted":true,"name":"name1","value":"vaue1"}]', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</UpdateVariableGroupResponse>","errorExample":""}]', + 'title' => '更新变量组', + ], + 'GetVariableGroup' => [ + 'summary' => '可以获取变量组。', + 'path' => '/organization/{organizationId}/variableGroups/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroup' => [ + 'title' => '变量组', + 'description' => '变量组', + 'type' => 'object', + 'properties' => [ + 'ccreatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '创建人阿里云账号id', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'description' => [ + 'title' => '变量组描述', + 'description' => '变量组描述', + 'type' => 'string', + 'example' => '变量组', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'id' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '更新人阿里云账号id', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'name' => [ + 'title' => '变量组名称', + 'description' => '变量组名称', + 'type' => 'string', + 'example' => '变量组', + ], + 'relatedPipelines' => [ + 'title' => '关联的流水线', + 'description' => '关联的流水线', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '关联的流水线Id', + 'description' => '关联的流水线Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'title' => '关联的流水线名称', + 'description' => '关联的流水线名称', + 'type' => 'string', + 'example' => '流水线', + ], + ], + ], + ], + 'variables' => [ + 'title' => '变量', + 'description' => '变量', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'example' => 'value1', + ], + 'name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'example' => 'name1', + ], + 'isEncrypted' => [ + 'title' => '是否加密', + 'description' => '是否加密', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"variableGroup\\": {\\n \\"ccreatorAccountId\\": \\"13232343434343\\",\\n \\"description\\": \\"变量组\\",\\n \\"updateTime\\": 1586863220000,\\n \\"id\\": 12234,\\n \\"modifierAccountId\\": \\"13232343434343\\",\\n \\"name\\": \\"变量组\\",\\n \\"relatedPipelines\\": [\\n {\\n \\"id\\": 1234,\\n \\"name\\": \\"流水线\\"\\n }\\n ],\\n \\"variables\\": [\\n {\\n \\"value\\": \\"value1\\",\\n \\"name\\": \\"name1\\",\\n \\"isEncrypted\\": true\\n }\\n ],\\n \\"createTime\\": 1586863220000\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVariableGroupResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <variableGroup>\\n <ccreatorAccountId>13232343434343</ccreatorAccountId>\\n <description>变量组</description>\\n <updateTime>1586863220000</updateTime>\\n <id>12234</id>\\n <modifierAccountId>13232343434343</modifierAccountId>\\n <name>变量组</name>\\n <relatedPipelines>\\n <id>1234</id>\\n <name>流水线</name>\\n </relatedPipelines>\\n <variables>\\n <value>value1</value>\\n <name>name1</name>\\n <isEncrypted>true</isEncrypted>\\n </variables>\\n <createTime>1586863220000</createTime>\\n </variableGroup>\\n</GetVariableGroupResponse>","errorExample":""}]', + 'title' => '获取变量组', + ], + 'ListVariableGroups' => [ + 'summary' => '可以获取变量组列表。', + 'path' => '/organization/{organizationId}/variableGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pageSort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序条件', + 'description' => '排序条件，默认id', + 'type' => 'string', + 'required' => false, + 'example' => 'ID', + ], + ], + [ + 'name' => 'pageOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '排序顺序 DESC降序 ASC升序', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页token，上一次请求的出参nextToken', + 'description' => '分页token，上一次请求的出参nextToken', + 'type' => 'string', + 'required' => false, + 'example' => 'aaaaaa', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回数，默认30', + 'description' => '最大返回数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'variableGroups' => [ + 'title' => '变量组', + 'description' => '变量组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '创建人阿里云账号id', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '更新人阿里云账号id', + 'type' => 'string', + 'example' => '13232343434343', + ], + 'description' => [ + 'title' => '变量组描述', + 'description' => '变量组描述', + 'type' => 'string', + 'example' => '变量组', + ], + 'name' => [ + 'title' => '变量组名称', + 'description' => '变量组名称', + 'type' => 'string', + 'example' => '变量组', + ], + 'id' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + 'relatedPipelines' => [ + 'title' => '关联的流水线', + 'description' => '关联的流水线', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '关联的流水线Id', + 'description' => '关联的流水线Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'name' => [ + 'title' => '关联的流水线名称', + 'description' => '关联的流水线名称', + 'type' => 'string', + 'example' => '流水线', + ], + ], + ], + ], + 'variables' => [ + 'title' => '变量', + 'description' => '变量', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'example' => 'value1', + ], + 'name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'example' => 'name1', + ], + 'isEncrypted' => [ + 'title' => '是否加密', + 'description' => '是否加密', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + ], + ], + ], + 'totalCount' => [ + 'title' => '变量组总数', + 'description' => '变量组总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'nextToken' => [ + 'title' => '下一次查询的token，为空表示最后一页', + 'description' => '下一次查询的token，为空表示最后一页', + 'type' => 'string', + 'example' => 'assassa', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"variableGroups\\": [\\n {\\n \\"creatorAccountId\\": \\"13232343434343\\",\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"13232343434343\\",\\n \\"description\\": \\"变量组\\",\\n \\"name\\": \\"变量组\\",\\n \\"id\\": 12234,\\n \\"relatedPipelines\\": [\\n {\\n \\"id\\": 1234,\\n \\"name\\": \\"流水线\\"\\n }\\n ],\\n \\"variables\\": [\\n {\\n \\"value\\": \\"value1\\",\\n \\"name\\": \\"name1\\",\\n \\"isEncrypted\\": true\\n }\\n ],\\n \\"createTime\\": 1586863220000\\n }\\n ],\\n \\"totalCount\\": 30,\\n \\"nextToken\\": \\"assassa\\"\\n}","errorExample":""},{"type":"xml","example":"<ListVariableGroupsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <variableGroups>\\n <creatorAccountId>13232343434343</creatorAccountId>\\n <updateTime>1586863220000</updateTime>\\n <modifierAccountId>13232343434343</modifierAccountId>\\n <description>变量组</description>\\n <name>变量组</name>\\n <id>12234</id>\\n <relatedPipelines>\\n <id>1234</id>\\n <name>流水线</name>\\n </relatedPipelines>\\n <variables>\\n <value>value1</value>\\n <name>name1</name>\\n <isEncrypted>true</isEncrypted>\\n </variables>\\n <createTime>1586863220000</createTime>\\n </variableGroups>\\n <totalCount>30</totalCount>\\n <nextToken>assassa</nextToken>\\n</ListVariableGroupsResponse>","errorExample":""}]', + 'title' => '获取变量组列表', + ], + 'CreatePipeline' => [ + 'summary' => '创建流水线API，支持创建YAML化流水线。', + 'path' => '/organization/{organizationId}/pipelines', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例流水线', + ], + ], + [ + 'name' => 'content', + 'in' => 'formData', + 'schema' => [ + 'description' => '流水线YAML描述，可参考文档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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'pipelinId' => [ + 'title' => '流水线id', + 'description' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11XXX', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelinId\\": 0,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\\\n\\"\\n}","type":"json"}]', + 'title' => '创建流水线', + ], + 'DeletePipeline' => [ + 'summary' => '可以删除流水线。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如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' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</DeletePipelineResponse>","errorExample":""}]', + 'title' => '删除流水线', + ], + 'DeletePipelineRelations' => [ + 'summary' => '删除流水线关联', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，目前只支持VARIABLE_GROUP', + 'description' => '关联的资源类型，目前只支持VARIABLE_GROUP', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + 'OSS_APP_ID', + ], + ], + ], + [ + 'name' => 'relObjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源id，目前只支持变量组id', + 'description' => '关联的资源id，目前只支持变量组id', + 'type' => 'string', + 'required' => true, + 'example' => '11', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '删除流水线关联', + ], + 'UpdatePipeline' => [ + 'summary' => '只支持更新YAML化流水线。', + 'path' => '/organization/{organizationId}/pipelines/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'formData', + 'schema' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例流水线', + ], + ], + [ + 'name' => 'content', + 'in' => 'formData', + 'schema' => [ + 'description' => '流水线YAML描述，可参考文档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', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'formData', + 'schema' => [ + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'string', + 'required' => true, + 'example' => '111xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\"\\n}","type":"json"}]', + 'title' => '更新流水线', + ], + 'StartPipelineRun' => [ + 'summary' => '可以运行流水线。', + 'path' => '/organizations/{organizationId}/pipelines/{pipelineId}/run', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如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' => '流水线运行参数,json字符串 branchModeBranchs 分支模式运行的分支 envs 环境变量 runningBranchs 运行分支 runningTags 运行代码tag comment 运行备注', + 'description' => '流水线运行参数'."\n" + .'分支模式运行分支 '."\n" + .'envs 运行变量'."\n" + .'runningBranchs 运行分支 key 为仓库地址 '."\n" + .'runningTags 运行tag key 为仓库地址'."\n" + .'runningPipelineArtifacts key为flow类型的制品源地址'."\n" + .'runningAcrArtifacts key为acr类型的制品源地址'."\n" + .'runningPackagesArtifacts key为package类型的制品源地址'."\n" + .'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' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineRunId' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineRunId\\": 1,\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<StartPipelineRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <pipelineRunId>1</pipelineRunId>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</StartPipelineRunResponse>","errorExample":""}]', + 'title' => '运行流水线', + ], + 'StopPipelineJobRun' => [ + 'summary' => '可以终止流水线任务运行。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行任务Id', + 'description' => '流水线运行任务Id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2324334', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '"\'', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\'\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\'</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</StopPipelineJobRunResponse>","errorExample":""}]', + 'title' => '终止流水线任务运行', + ], + 'StopPipelineRun' => [ + 'summary' => '可以终止流水线运行。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '223', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopPipelineRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n</StopPipelineRunResponse>","errorExample":""}]', + 'title' => '终止流水线运行', + ], + 'UpdatePipelineBaseInfo' => [ + 'summary' => '更新流水线基本信息。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/baseInfo', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'description' => '流水线名称', + 'type' => 'string', + 'required' => true, + 'example' => '流水线名称', + ], + ], + [ + 'name' => 'envId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 0 日常环境'."\n" + ."\n" + .'- 1 预发环境'."\n" + ."\n" + .'- 2 正式环境', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'tagList', + 'in' => 'query', + 'schema' => [ + 'description' => '标签Id，多个逗号', + 'type' => 'string', + 'required' => false, + 'example' => '"11,222,33"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\"\\n}","type":"json"}]', + 'title' => '更新流水线基本信息', + ], + 'RetryPipelineJobRun' => [ + 'summary' => '可以重试流水线任务运行。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true调用成功，false调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RetryPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n</RetryPipelineJobRunResponse>","errorExample":""}]', + 'title' => '重试流水线任务运行', + ], + 'SkipPipelineJobRun' => [ + 'summary' => '可以跳过流水线任务运行。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/skip', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'description' => 'true 调用成功，false调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '跳过流水线任务运行', + ], + 'PassPipelineValidate' => [ + 'summary' => '可以通过人工卡点。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/pass', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如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' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11222', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '1111', + 'description' => '任务Id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'string', + 'required' => true, + 'example' => '111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '通过人工卡点', + ], + 'RefusePipelineValidate' => [ + 'summary' => '可以拒绝人工卡点。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/refuse', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '12222', + 'description' => '12222', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '1', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '流水线运行实例id', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '11111', + 'description' => '任务Id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<RefusePipelineValidateResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>错误信息</errorMessage>\\n <success>false</success>\\n <errorCode>错误码</errorCode>\\n</RefusePipelineValidateResponse>","errorExample":""}]', + 'title' => '拒绝人工卡点', + ], + 'AddPipelineRelations' => [ + 'summary' => '添加流水线关联', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'description' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + 'OOS_APP_ID', + ], + ], + ], + [ + 'name' => 'relObjectIds', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源id，暂只支持变量组id', + 'description' => '关联的资源id，暂只支持变量组id，多个逗号分割', + 'type' => 'string', + 'required' => true, + 'example' => '11,22', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '添加流水线关联', + ], + 'GetPipeline' => [ + 'summary' => '可以获取流水线信息。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => "\n" + .'企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'pipeline' => [ + 'title' => '流水线', + 'description' => '流水线', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云账号id', + 'description' => '创建者阿里云账号id', + 'type' => 'string', + 'example' => '112222122', + ], + 'envId' => [ + 'title' => '环境id 0 日常环境 1预发环境 2正式环境', + 'description' => '环境id 0 日常环境 1预发环境 2正式环境', + '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' => '流水线分组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'modifierAccountId' => [ + 'title' => '更新人阿里云账号id', + 'description' => '更新人阿里云账号id', + 'type' => 'string', + 'example' => '112222122', + ], + 'name' => [ + 'title' => '流水线名称', + 'description' => '流水线名称', + 'type' => 'string', + 'example' => '流水线', + ], + 'tagList' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '标签id', + 'description' => '标签id', + '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' => '代码源类型aliyunGit 阿里云代码库 customGitlab 自建git giteeGit 码云 codeup Codeup git 通用git gitlab gitlab bitbucket bitbucket githubOAuth github', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'data' => [ + 'title' => '代码数据', + 'description' => '代码数据', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'title' => '分支', + 'description' => '分支', + 'type' => 'string', + 'example' => 'master', + ], + 'serviceConnectionId' => [ + 'title' => '服务连接Id', + 'description' => '服务连接Id', + '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' => 'webhhook地址', + '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' => '是否设置clone深度', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cloneDepth' => [ + 'title' => '克隆深度', + 'description' => '克隆深度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'credentialId' => [ + 'title' => 'Credential Id', + 'description' => '证书Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '222', + ], + 'credentialType' => [ + 'title' => 'Credential Type', + 'description' => '证书类型', + 'type' => 'string', + 'example' => 'region-ssh', + ], + 'credentialLabel' => [ + 'title' => 'Credential Label', + 'description' => '证书显示名称', + 'type' => 'string', + 'example' => '企业公钥', + ], + 'namespace' => [ + 'title' => 'github命名空间', + 'description' => 'github命名空间', + 'type' => 'string', + 'example' => 'asasasas', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipeline\\": {\\n \\"creatorAccountId\\": \\"112222122\\",\\n \\"envId\\": 0,\\n \\"envName\\": \\"日常环境\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"groupId\\": 1111,\\n \\"modifierAccountId\\": \\"112222122\\",\\n \\"name\\": \\"流水线\\",\\n \\"tagList\\": [\\n {\\n \\"id\\": 22,\\n \\"name\\": \\"标签1\\"\\n }\\n ],\\n \\"pipelineConfig\\": {\\n \\"flow\\": \\"schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: \'10_1626147407245\' templateType: task templateSign: \'\' templateBatchUpdate: \'N\' extraInfo: \'\' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: \'10_1626147407245__11_1626147407249\' command: | # input your command here echo hello,world! ARTIFACTS: \'\' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: \'${INPUTS.ENGINE_PIPELINE_NAME}\' ENGINE_PIPELINE_ID: \'${INPUTS.ENGINE_PIPELINE_ID}\' ENGINE_PIPELINE_INST_ID: \'${INPUTS.ENGINE_PIPELINE_INST_ID}\' ENGINE_PIPELINE_INST_NUMBER: \'${INPUTS.ENGINE_PIPELINE_INST_NUMBER}\' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []\\",\\n \\"settings\\": \\"{}\\",\\n \\"sources\\": [\\n {\\n \\"sign\\": \\"xxsxsxs\\",\\n \\"type\\": \\"Codeup\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"serviceConnectionId\\": 12,\\n \\"label\\": \\"cdup/ss\\",\\n \\"isTrigger\\": true,\\n \\"repo\\": \\"https://codeup.aliyun.com/test.git\\",\\n \\"triggerFilter\\": \\".*\\",\\n \\"webhook\\": \\"https://flow.aliyun/webhook/asassasa\\",\\n \\"events\\": [\\n \\"push\\"\\n ],\\n \\"isBranchMode\\": false,\\n \\"isSubmodule\\": false,\\n \\"isCloneDepth\\": true,\\n \\"cloneDepth\\": 1,\\n \\"credentialId\\": 222,\\n \\"credentialType\\": \\"region-ssh\\",\\n \\"credentialLabel\\": \\"企业公钥\\",\\n \\"namespace\\": \\"asasasas\\"\\n }\\n }\\n ]\\n }\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPipelineResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <pipeline>\\n <creatorAccountId>112222122</creatorAccountId>\\n <envId>0</envId>\\n <envName>日常环境</envName>\\n <createTime>1586863220000</createTime>\\n <updateTime>1586863220000</updateTime>\\n <groupId>1111</groupId>\\n <modifierAccountId>112222122</modifierAccountId>\\n <name>流水线</name>\\n <tagList>\\n <id>22</id>\\n <name>标签1</name>\\n </tagList>\\n <pipelineConfig>\\n <flow>schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: \'10_1626147407245\' templateType: task templateSign: \'\' templateBatchUpdate: \'N\' extraInfo: \'\' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: \'10_1626147407245__11_1626147407249\' command: | # input your command here echo hello,world! ARTIFACTS: \'\' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: \'${INPUTS.ENGINE_PIPELINE_NAME}\' ENGINE_PIPELINE_ID: \'${INPUTS.ENGINE_PIPELINE_ID}\' ENGINE_PIPELINE_INST_ID: \'${INPUTS.ENGINE_PIPELINE_INST_ID}\' ENGINE_PIPELINE_INST_NUMBER: \'${INPUTS.ENGINE_PIPELINE_INST_NUMBER}\' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []</flow>\\n <settings>{}</settings>\\n <sources>\\n <sign>xxsxsxs</sign>\\n <type>Codeup</type>\\n <data>\\n <branch>master</branch>\\n <serviceConnectionId>12</serviceConnectionId>\\n <label>cdup/ss</label>\\n <isTrigger>true</isTrigger>\\n <repo>https://codeup.aliyun.com/test.git</repo>\\n <triggerFilter>.*</triggerFilter>\\n <webhook>https://flow.aliyun/webhook/asassasa</webhook>\\n <events>push</events>\\n <isBranchMode>false</isBranchMode>\\n <isSubmodule>false</isSubmodule>\\n <isCloneDepth>true</isCloneDepth>\\n <cloneDepth>1</cloneDepth>\\n <credentialId>222</credentialId>\\n <credentialType>region-ssh</credentialType>\\n <credentialLabel>企业公钥</credentialLabel>\\n <namespace>asasasas</namespace>\\n </data>\\n </sources>\\n </pipelineConfig>\\n </pipeline>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</GetPipelineResponse>","errorExample":""}]', + 'title' => '获取流水线信息', + ], + 'GetPipelineRun' => [ + 'summary' => '可以获取流水线运行实例。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线id', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'pipelineRun' => [ + 'title' => '流水线运行实例', + 'description' => '流水线运行实例', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云账号id', + 'description' => '创建者阿里云账号id', + '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' => '更新人阿里云账号id', + 'type' => 'string', + 'example' => '11111111111', + ], + 'pipelineId' => [ + 'title' => '流水线Id', + 'description' => '流水线Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'pipelineRunId' => [ + 'title' => '流水线运行实例id', + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'title' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'description' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'triggerMode' => [ + 'title' => '触发模式 1人工触发 2定时触发 3代码提交触发', + 'description' => '- 触发模式'."\n" + .' '."\n" + .' 1人工触发'."\n" + .' '."\n" + .' 2定时触发 '."\n" + ."\n" + .' 3代码提交触发'."\n" + .' '."\n" + .' 5流水线触发'."\n" + ."\n" + .' 6WEBHOOK触发', + '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' => '代码库类型 Codeup codeup 代码源 aliyunGit 阿里云code giteeGit 码云', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'data' => [ + 'title' => '代码源信息', + 'description' => '代码源信息', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'title' => '分支', + 'description' => '代码分支', + 'type' => 'string', + 'example' => 'master', + ], + 'commint' => [ + 'title' => '提交信息 json数据', + 'description' => '提交信息 JSON 数据', + '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' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + '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' => '任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21212', + ], + 'name' => [ + 'title' => '任务名称', + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'Java构建', + ], + 'params' => [ + 'title' => '触发参数', + 'description' => '触发参数', + 'type' => 'string', + 'example' => '{}', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'startTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'actions' => [ + 'title' => '后续操作', + 'description' => '后续操作,具体参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'API名称', + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'string', + 'example' => 'PassPipelineValidate', + ], + 'disable' => [ + 'title' => '是否可用', + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pipelineRun\\": {\\n \\"creatorAccountId\\": \\"1111111111\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"pipelineId\\": 1234,\\n \\"pipelineRunId\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"triggerMode\\": 1,\\n \\"stageGroup\\": [\\n [\\n \\"阶段名称\\"\\n ]\\n ],\\n \\"sources\\": [\\n {\\n \\"sign\\": \\"assaaaaaasasasa\\",\\n \\"type\\": \\"Codeup\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"commint\\": \\"{}\\",\\n \\"repo\\": \\"http://codeup.aliyun.com/a.git\\"\\n }\\n }\\n ],\\n \\"stages\\": [\\n {\\n \\"name\\": \\"Java构建\\",\\n \\"stageInfo\\": {\\n \\"endTime\\": 1586863220000,\\n \\"startTime\\": 1586863220000,\\n \\"name\\": \\"Java构建\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"jobs\\": [\\n {\\n \\"endTime\\": 1586863220000,\\n \\"id\\": 21212,\\n \\"name\\": \\"Java构建\\",\\n \\"params\\": \\"{}\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": 1586863220000,\\n \\"actions\\": [\\n {\\n \\"type\\": \\"PassPipelineValidate\\",\\n \\"disable\\": true,\\n \\"params\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '获取流水线运行实例', + 'description' => 'API名称：GetPipelineRun', + ], + 'ListPipelineRuns' => [ + 'summary' => '可以获取流水线运行实例列表。', + 'path' => '/organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如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', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态 状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'description' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回数量', + 'description' => '最大返回数量 ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页Token', + 'description' => '分页token', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aaaaaa', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线id', + 'description' => '流水线ID，可在流水线链接中获取，如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' => '- 触发模式'."\n" + .' '."\n" + .' 1人工触发'."\n" + .' '."\n" + .' 2定时触发 '."\n" + ."\n" + .' 3代码提交触发'."\n" + .' '."\n" + .' 5流水线触发'."\n" + ."\n" + .' 6WEBHOOK触发', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '下一个分页token，为空时，表示没有下一页', + 'description' => '下一个分页token，为空时，表示没有下一页', + 'type' => 'string', + 'example' => 'xzxsasasaas', + ], + 'pipelineRuns' => [ + 'title' => '流水线运行实例', + 'description' => '流水线运行实例', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineId' => [ + 'title' => '流水线id', + 'description' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'startTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'creatorAccountId' => [ + 'title' => '运行人阿里云账号id', + 'description' => '运行人阿里云账号id', + 'type' => 'string', + 'example' => '1222222222', + ], + 'endTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'pipelineRunId' => [ + 'title' => '流水线实例id', + 'description' => '流水线实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'triggerMode' => [ + 'title' => '触发模式', + 'description' => '- 触发模式'."\n" + .' '."\n" + .' 1人工触发'."\n" + .' '."\n" + .' 2定时触发 '."\n" + ."\n" + .' 3代码提交触发'."\n" + .' '."\n" + .' 5流水线触发'."\n" + ."\n" + .' 6WEBHOOK触发', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'title' => '运行状态', + 'description' => '运行状态', + 'type' => 'string', + 'example' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"errorCode\\": \\"”“\\",\\n \\"success\\": true,\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"xzxsasasaas\\",\\n \\"pipelineRuns\\": [\\n {\\n \\"pipelineId\\": 1234,\\n \\"startTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"1222222222\\",\\n \\"endTime\\": 1586863220000,\\n \\"pipelineRunId\\": 11,\\n \\"triggerMode\\": 1,\\n \\"status\\": \\"状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPipelineRunsResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>”“</errorMessage>\\n <errorCode>”“</errorCode>\\n <success>true</success>\\n <totalCount>50</totalCount>\\n <nextToken>xzxsasasaas</nextToken>\\n <pipelineRuns>\\n <pipelineId>1234</pipelineId>\\n <startTime>1586863220000</startTime>\\n <creatorAccountId>1222222222</creatorAccountId>\\n <endTime>1586863220000</endTime>\\n <pipelineRunId>11</pipelineRunId>\\n <triggerMode>1</triggerMode>\\n <status>状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中</status>\\n </pipelineRuns>\\n</ListPipelineRunsResponse>","errorExample":""}]', + 'title' => '获取流水线运行实例列表', + ], + 'ListPipelines' => [ + 'summary' => '获取流水线列表。', + 'path' => '/organization/{organizationId}/pipelines', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => [ + 'title' => '流水线名称', + 'description' => '流水线名称', + 'type' => 'string', + 'required' => false, + 'example' => '流水线A', + ], + ], + [ + 'name' => 'creatorAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '创建人阿里云账号Id', + 'description' => '创建者阿里云账号Id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '112122121', + ], + ], + [ + 'name' => 'executeAccountIds', + 'in' => 'query', + 'schema' => [ + 'title' => '执行人阿里云账号id', + 'description' => '执行者阿里云账号id，多个逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '1111111', + ], + ], + [ + 'name' => 'statusList', + 'in' => 'query', + 'schema' => [ + 'title' => '状态列表，多个逗号分割', + 'description' => '状态列表，多个逗号分割，SUCCESS,RUNNING,FAIL,CANCELED,WAITING', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING,SUCCESS', + ], + ], + [ + 'name' => 'createStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '创建开始时间', + 'description' => '创建开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'createEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '创建结束时间', + 'description' => '创建结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '执行开始时间', + 'description' => '执行开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'executeEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '执行结束时间', + 'description' => '执行结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586863220000', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '返回的总数', + 'description' => '最大返回数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页Token', + 'description' => '分页token', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aaaaaaaaaa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'nextToken' => [ + 'title' => '分页Token', + 'description' => '分页Token', + 'type' => 'string', + 'example' => 'ssaassasass', + ], + 'pipelines' => [ + 'title' => '流水线', + 'description' => '流水线', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineName' => [ + 'title' => '流水线名称', + 'description' => '流水线名称', + 'type' => 'string', + 'example' => '流水线', + ], + 'pipelineId' => [ + 'title' => '流水线id', + 'description' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '124', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'creatorAccountId' => [ + 'title' => '创建人阿里云账号id', + 'description' => '创建人阿里云账号id', + 'type' => 'string', + 'example' => '22121222', + ], + 'groupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"totalCount\\": 50,\\n \\"nextToken\\": \\"ssaassasass\\",\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"流水线\\",\\n \\"pipelineId\\": 124,\\n \\"createTime\\": 1586863220000,\\n \\"creatorAccountId\\": \\"22121222\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPipelinesResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <errorCode>\\"\\"</errorCode>\\n <success>true</success>\\n <totalCount>50</totalCount>\\n <nextToken>ssaassasass</nextToken>\\n <pipelines>\\n <pipelineName>流水线</pipelineName>\\n <pipelineId>124</pipelineId>\\n <createTime>1586863220000</createTime>\\n <creatorAccountId>22121222</creatorAccountId>\\n </pipelines>\\n</ListPipelinesResponse>","errorExample":""}]', + 'title' => '获取流水线列表', + ], + 'GetPipelineArtifactUrl' => [ + 'summary' => '获取流水线构建产物下载地址。', + 'path' => '/organization/{organizationId}/pipeline/getArtifactDownloadUrl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'filePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径，可通过API https://help.aliyun.com/document_detail/460565.html', + 'type' => 'string', + 'required' => true, + 'example' => '/test/test/test.tgz', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称，可通过API https://help.aliyun.com/document_detail/460565.html 获取', + 'type' => 'string', + 'required' => true, + 'example' => 'test.tgz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'fileUrl' => [ + 'description' => '文件临时下载路径，一个小时有效期', + 'type' => 'string', + 'example' => 'http://aliyun.com/', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com/\\"\\n}","type":"json"}]', + 'title' => '获取流水线构建产物下载地址', + ], + 'GetPipelineEmasArtifactUrl' => [ + 'summary' => '获取流水线emas构建产物临时下载地址。', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/emas/artifact/{emasJobInstanceId}/{md5}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'emasJobInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'emas任务id，可通过API https://help.aliyun.com/document_detail/460565.html', + 'type' => 'string', + 'required' => true, + 'example' => 'Psaxsa', + ], + ], + [ + 'name' => 'md5', + 'in' => 'path', + 'schema' => [ + 'description' => 'emas构建产物md5，可通过API https://help.aliyun.com/document_detail/460565.html', + 'type' => 'string', + 'required' => true, + 'example' => 'assasas', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'serviceConnectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务连接id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'fileUrl' => [ + 'description' => 'emas构建产物临时下载地址，一个小时有效期', + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"fileUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'title' => '获取流水线emas构建产物临时下载地址', + ], + 'GetPipelineScanReportUrl' => [ + 'summary' => '获取流水线扫描报告临时下载地址。', + 'path' => '/organization/{organizationId}/pipeline/getPipelineScanReportUrl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'reportPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '扫描报告路径，可通过API https://help.aliyun.com/document_detail/460565.html 获取', + 'type' => 'string', + 'required' => true, + 'example' => '/test/test/test.html', + 'maxLength' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'reportUrl' => [ + 'description' => '扫描报告的临时下载地址，一个小时有效期', + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"reportUrl\\": \\"http://aliyun.com\\"\\n}","type":"json"}]', + 'title' => '获取流水线扫描报告临时下载地址', + ], + 'ListPipelineJobHistorys' => [ + 'summary' => '获取流水线任务的执行历史。', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/job/historys', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线Id', + 'type' => 'string', + 'required' => true, + 'example' => '123', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'description' => '任务分类，暂时只支持DEPLOY', + 'type' => 'string', + 'required' => true, + 'example' => 'DEPLOY', + 'enum' => [ + 'DEPLOY', + ], + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'description' => '任务标识', + 'type' => 'string', + 'required' => true, + 'example' => '10_ssasasa', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => 'xsaxsa', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大数据，最多支持50', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '50', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'jobs' => [ + 'description' => '任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务', + 'type' => 'object', + 'properties' => [ + 'jobName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => '任务名称', + ], + 'identifier' => [ + 'description' => '任务标识', + 'type' => 'string', + 'example' => '10_xaxxsxa', + ], + 'pipelineId' => [ + 'description' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'executeNumber' => [ + 'description' => '任务第几次执行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'jobId' => [ + 'description' => '任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'pipelineRunId' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'sources' => [ + 'description' => '任务运行的代码源信息', + 'type' => 'string', + 'example' => '{}', + ], + 'status' => [ + 'description' => '任务执行状态', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'operatorAccountId' => [ + 'description' => '运行人aliyunPK', + 'type' => 'string', + 'example' => 'ssaasssa', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '下一页token', + 'type' => 'string', + 'example' => 'xsxxs', + ], + 'totalCount' => [ + 'description' => '任务总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"jobs\\": [\\n {\\n \\"jobName\\": \\"任务名称\\",\\n \\"identifier\\": \\"10_xaxxsxa\\",\\n \\"pipelineId\\": 123,\\n \\"executeNumber\\": 1,\\n \\"jobId\\": 123,\\n \\"pipelineRunId\\": 123,\\n \\"sources\\": \\"{}\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"operatorAccountId\\": \\"ssaasssa\\"\\n }\\n ],\\n \\"nextToken\\": \\"xsxxs\\",\\n \\"totalCount\\": 20\\n}","type":"json"}]', + 'title' => '获取流水线任务的执行历史', + ], + 'ListPipelineJobs' => [ + 'summary' => '按任务分类获取流水线执行的任务。', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/jobs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线id', + 'type' => 'string', + 'required' => true, + 'example' => '1111', + 'maxLength' => 1000, + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'description' => '任务分类，暂只支持DEPLOY ', + 'type' => 'string', + 'required' => true, + 'example' => 'DEPLOY', + 'enum' => [ + 'DEPLOY', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '”“', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '”“', + ], + 'jobs' => [ + 'description' => '流水线执行任务', + 'type' => 'array', + 'items' => [ + 'description' => '流水线执行任务', + 'type' => 'object', + 'properties' => [ + 'jobName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => '任务名称', + ], + 'identifier' => [ + 'description' => '任务的标识', + 'type' => 'string', + 'example' => 'ss_saxsxsxs', + ], + 'lastJobId' => [ + 'description' => '最后运行的任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'lastJobParams' => [ + 'description' => '最后运行的任务的参数', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidIdentifier.NotFound', + 'errorMessage' => 'space id is error or not exist.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"”“\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"”“\\",\\n \\"jobs\\": [\\n {\\n \\"jobName\\": \\"任务名称\\",\\n \\"identifier\\": \\"ss_saxsxsxs\\",\\n \\"lastJobId\\": 123,\\n \\"lastJobParams\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '按任务分类获取流水线执行的任务', + ], + 'LogPipelineJobRun' => [ + 'summary' => '可以查询任务运行日志。', + 'path' => '/organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/job/{jobId}/logs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12222', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务id，可通过API https://help.aliyun.com/document_detail/460565.html 获取任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'pipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'log' => [ + 'description' => '日志', + 'type' => 'object', + 'properties' => [ + 'more' => [ + 'description' => '是否还有最新日志', + 'type' => 'boolean', + 'example' => 'true', + ], + 'content' => [ + 'description' => '日志内容', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCluster.NotFound', + 'errorMessage' => 'No cluster is available to generate the workspace.', + ], + [ + 'errorCode' => 'InvalidCodeUrl.NotSupportSVN', + 'errorMessage' => 'The parameter codeUrl is invalid. SVN is not supported.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => 'No resource is found. You cannot create the workspace. Please try again later.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFoun', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceRole.NotFound', + 'errorMessage' => 'The member role is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberCouldNotDeleteOwner', + 'errorMessage' => 'Resource owner cannot be deleted.', + ], + [ + 'errorCode' => 'InvalidUser.ResourceMemberNotExists', + 'errorMessage' => 'The resource member does not exist.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + [ + 'errorCode' => 'InvalidWorkspaceStatus.NotSuccess', + 'errorMessage' => 'The workspace status is invalid. You can only operate workspaces with the SUCCESS status.', + ], + [ + 'errorCode' => 'InvalidWorkspaceTemplate.NotFound', + 'errorMessage' => 'The parameter workspaceTemplate is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.AccessDenied', + 'errorMessage' => 'The user is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + [ + 'errorCode' => 'InvalidPipeline.NotFound', + 'errorMessage' => 'The pipeline is not found.', + ], + [ + 'errorCode' => 'InvalidPipelineRun.NotFound', + 'errorMessage' => 'The pipeline execution instance is not found.', + ], + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidWorkspace.NotFound', + 'errorMessage' => 'The workspace is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"log\\": {\\n \\"more\\": true,\\n \\"content\\": \\"success\\"\\n },\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<LogPipelineJobRunResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMessage>\\"\\"</errorMessage>\\n <log>\\n <more>true</more>\\n <content>success</content>\\n </log>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n</LogPipelineJobRunResponse>","errorExample":""}]', + 'title' => '查询任务运行日志', + ], + 'ListPipelineRelations' => [ + 'summary' => '获取流水线关联列表', + 'path' => '/organization/{organizationId}/{pipelineId}/pipelineRelations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'pipelineId', + 'in' => 'path', + 'schema' => [ + 'title' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'description' => '流水线ID，可在流水线链接中获取，如https://flow.aliyun.com/pipelines/【PipelineId】/current', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'relObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'description' => '关联的资源类型，暂只支持VARIABLE_GROUP', + 'type' => 'string', + 'required' => true, + 'example' => 'VARIABLE_GROUP', + 'enum' => [ + 'VARIABLE_GROUP', + 'OSS_APP_ID', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'pipelineRelations' => [ + 'title' => '变量组', + 'description' => '变量组', + 'type' => 'array', + 'items' => [ + 'description' => '关联对象id', + 'type' => 'object', + 'properties' => [ + 'refObjectId' => [ + 'title' => '变量组id', + 'description' => '变量组id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12234', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"pipelineRelations\\": [\\n {\\n \\"refObjectId\\": 12234\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取流水线关联列表', + ], + 'WorkitemAttachmentCreate' => [ + 'summary' => '将文件作为工作项的附件，这是工作项上传附件的第三步，前两步可以查看 GetWorkitemAttachmentCreatemeta(获取工作项上传附件的信息) 接口的描述。', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '工作项id，同workitemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'fileKey' => [ + 'description' => '文件key，对应GetWorkitemAttachmentCreatemeta接口返回的dir值，前提是已经成功上传完文件', + 'type' => 'string', + 'required' => true, + 'example' => '1106473328927498/1106473328927498/5ec071g0e5ij85fche8cddchje.xlsx', + ], + 'originalFilename' => [ + 'description' => '上传的文件原始完整名称', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx.tgz', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'F590C9D8-E908-5B6C-95AC-56B7E8011FFA', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'errorMessage' => [ + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFoundntraceId: 2137844496.4337.16624448853053831', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F590C9D8-E908-5B6C-95AC-56B7E8011FFA\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"errorMessage\\": \\"InvalidTagGroup.IdNotFoundntraceId: 2137844496.4337.16624448853053831\\",\\n \\"success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '关联文件为工作项的附件', + ], + 'ListWorkitemAttachments' => [ + 'summary' => '获取工作项附件列表。', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachments', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => false, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '工作项workitemId，工作项唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '11234455454355', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMsg' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'attachments' => [ + 'description' => '附件列表', + 'type' => 'array', + 'items' => [ + 'description' => '附件', + 'type' => 'object', + 'properties' => [ + 'fileIdentifier' => [ + 'description' => '文件唯一标识', + 'type' => 'string', + 'example' => 'dflkjlsdddsdl234lkjfg', + ], + 'fileName' => [ + 'description' => '文件名称', + 'type' => 'string', + 'example' => 'Artifacts_1565193_1.tgz', + ], + 'fileSuffix' => [ + 'description' => '文件后缀', + 'type' => 'string', + 'example' => 'tgz', + ], + 'size' => [ + 'description' => '文件内容大小，单位：bytes', + 'type' => 'string', + 'example' => '50', + ], + 'url' => [ + 'description' => '下载的url', + 'type' => 'string', + 'example' => 'http://grace-share.oss-cn-hangzhou.aliyuncs.com/qf%2Fheap.bin?Expires=1675750082&OSSAccessKeyId=xxxxxxxx&Signature=xxxxx%3D', + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545726028000', + ], + 'creator' => [ + 'description' => '创建人的阿里云accountId', + 'type' => 'string', + 'example' => '237109', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": true,\\n \\"attachments\\": [\\n {\\n \\"fileIdentifier\\": \\"dflkjlsdddsdl234lkjfg\\",\\n \\"fileName\\": \\"Artifacts_1565193_1.tgz\\",\\n \\"fileSuffix\\": \\"tgz\\",\\n \\"size\\": \\"50\\",\\n \\"url\\": \\"http://grace-share.oss-cn-hangzhou.aliyuncs.com/qf%2Fheap.bin?Expires=1675750082&OSSAccessKeyId=xxxxxxxx&Signature=xxxxx%3D\\",\\n \\"gmtCreate\\": 1545726028000,\\n \\"creator\\": \\"237109\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取工作项附件列表', + ], + 'CreateWorkitemV2' => [ + 'summary' => '创建工作项，可以用于创建项目下的工作项，包含（需求、缺陷、任务、风险、主题等）。', + 'path' => '/organization/{organizationId}/workitem', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'description' => '工作项标题', + 'type' => 'string', + 'required' => true, + 'example' => '测试工作项', + ], + 'description' => [ + 'description' => '描述，描述区上传图片，推荐只上传小于1M的图片，请在接口description字段中插入如下格式：'."\n" + .'\\<img src="data:image/png;base64,*****************************"/> 其中******为图片内容的base64编码，png为图片的格式，按实际图片格式填写即可', + 'type' => 'string', + 'required' => false, + 'example' => '测试内容', + ], + 'assignedTo' => [ + 'description' => '负责人id', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'spaceIdentifier' => [ + 'description' => '项目唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'category' => [ + 'description' => '工作项的类型id，枚举值为：Req、Bug、Task、Topic', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + 'workitemTypeIdentifier' => [ + 'description' => '工作项类型id，可以通过[获取工作项类型接口](https://help.aliyun.com/document_detail/460485.html)，查看对应项目下有哪些工作项类型可以选择', + 'type' => 'string', + 'required' => true, + 'example' => '9uy29901re573f561d69jn40', + ], + 'fieldValueList' => [ + 'description' => '字段值列表，可以通过[获取工作项字段列表接口](https://help.aliyun.com/document_detail/460486.html)获取对应工作项类型有哪些字段可以设置', + 'type' => 'array', + 'items' => [ + 'description' => '字段值列表，可以通过获取工作项字段列表接口获取对应工作项类型有哪些字段可以设置', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'description' => '字段唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'description' => '字段值', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'parentIdentifier' => [ + 'description' => '父工作项id', + 'type' => 'string', + 'required' => false, + 'example' => '11223331122', + ], + 'versions' => [ + 'description' => '版本列表，填写版本的唯一标识列表', + 'type' => 'array', + 'items' => [ + 'description' => '版本唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '[1111,1223]', + ], + 'required' => false, + ], + 'sprintIdentifier' => [ + 'description' => '迭代的唯一标识id', + 'type' => 'string', + 'required' => false, + 'example' => '455532323455', + ], + 'tags' => [ + 'description' => '标签列表，填写标签唯一标识列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签唯一标识，标签id', + 'type' => 'string', + 'required' => false, + 'example' => '[1112,3344]', + ], + 'required' => false, + ], + 'trackers' => [ + 'description' => '抄送人account id列表', + 'type' => 'array', + 'items' => [ + 'description' => '抄送人account id', + 'type' => 'string', + 'required' => false, + 'example' => '1123344', + ], + 'required' => false, + ], + 'participants' => [ + 'description' => '参与人account id列表', + 'type' => 'array', + 'items' => [ + 'description' => '参与人account id', + 'type' => 'string', + 'required' => false, + 'example' => '1234454', + ], + 'required' => false, + ], + 'verifier' => [ + 'description' => '验证者的account id', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + ], + 'required' => false, + 'docRequired' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'EAE03103-5497-58D1-9169-E524DDE8604C', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => 'SYSTEM_UNKNOWN_ERROR', + ], + 'success' => [ + 'description' => 'true或者false', + 'type' => 'string', + 'example' => 'true', + ], + 'workitemIdentifier' => [ + 'description' => '工作项id，唯一标识', + 'type' => 'string', + 'example' => '11234455454355', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EAE03103-5497-58D1-9169-E524DDE8604C\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"errorMessage\\": \\"SYSTEM_UNKNOWN_ERROR\\",\\n \\"success\\": \\"true\\",\\n \\"workitemIdentifier\\": \\"11234455454355\\"\\n}","type":"json"}]', + 'title' => '创建工作项(需求/缺陷/任务)', + 'description' => '填写的字段信息可以参考：[获取工作项字段信息 ](https://help.aliyun.com/document_detail/460486.html) 以及 [获取项目下工作项类型接口](https://help.aliyun.com/document_detail/460485.html) 两个接口。'."\n" + ."\n\n" + .'描述区上传图片，整个描述区大小不能超过5M，建议只上传小于1M的图片，请在接口description字段中插入如下格式：'."\n" + .'\\<img src="data:image/png;base64,*****************************"/> '."\n" + .'其中******为图片内容的base64编码，png为图片的格式，按实际图片格式填写即可', + 'responseParamsDescription' => 'workitemIdentifier为成功创建工作项后对应的工作项id', + ], + 'CreateWorkitemRecord' => [ + 'summary' => '登记实际工时。', + 'path' => '/organization/{organizationId}/workitems/record', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '工作项id，即workitemId', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'actualTime' => [ + 'title' => '花费工时，最大为9999', + 'description' => '花费工时，最大为9999', + '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' => '登记人,为用户的aliyunPk', + 'type' => 'string', + 'required' => true, + 'example' => '1316458xxxxx41068', + ], + 'gmtStart' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'required' => true, + 'example' => '1667205617061', + ], + 'gmtEnd' => [ + 'title' => '结束时间，开始时间不能大于结束时间', + 'description' => '结束时间，开始时间不能大于结束时间', + 'type' => 'string', + 'required' => true, + 'example' => '1646323200000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WorkitemTime' => [ + 'description' => '工作时间', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '工时唯一标识', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '工作项id', + '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' => '用户id', + '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' => 'null标识普通用户', + ], + 'nameEn' => [ + 'description' => '用户英文名', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'gender' => [ + 'description' => '性别', + 'type' => 'string', + 'example' => '保留字段', + ], + 'mobile' => [ + 'description' => '电话号码', + 'type' => 'string', + 'example' => '保留字段', + ], + 'email' => [ + 'description' => '邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nickNamePinyin' => [ + 'description' => '昵称拼音', + 'type' => 'string', + 'example' => 'wangwu'."\n", + ], + 'realNamePinyin' => [ + 'description' => '实际姓名拼音', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayNickName' => [ + 'description' => '展示的昵称', + 'type' => 'string', + 'example' => '王五', + ], + 'displayRealName' => [ + 'description' => '展示的实际名', + 'type' => 'string', + 'example' => '王五', + ], + 'displayName' => [ + 'description' => '展示名', + 'type' => 'string', + 'example' => '王五', + ], + 'dingTalkId' => [ + 'description' => '钉钉id', + 'type' => 'string', + 'example' => 'xx12322', + ], + 'tbRoleId' => [ + 'description' => '角色id', + 'type' => 'string', + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + 'isDisabled' => [ + 'description' => '是否可见', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + 'gmtStart' => [ + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617061', + ], + 'gmtEnd' => [ + 'description' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667205617089', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": true,\\n \\"WorkitemTime\\": {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"workitemIdentifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"actualTime\\": 12,\\n \\"type\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"description\\": \\"这是一段描述\\",\\n \\"recordUser\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王武\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"stamp\\": \\"null标识普通用户\\",\\n \\"nameEn\\": \\"wangwu\\",\\n \\"gender\\": \\"保留字段\\",\\n \\"mobile\\": \\"保留字段\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"nickNamePinyin\\": \\"wangwu\\\\n\\",\\n \\"realNamePinyin\\": \\"wangwu\\",\\n \\"displayNickName\\": \\"王五\\",\\n \\"displayRealName\\": \\"王五\\",\\n \\"displayName\\": \\"王五\\",\\n \\"dingTalkId\\": \\"xx12322\\",\\n \\"tbRoleId\\": \\"1e9903d8b3f1xxxxxf9286ef5\\",\\n \\"isDisabled\\": true\\n },\\n \\"gmtStart\\": 1667205617061,\\n \\"gmtEnd\\": 1667205617089\\n }\\n}","type":"json"}]', + 'title' => '登记实际工时', + 'description' => '登记实际工时。', + ], + 'CreateWorkitem' => [ + 'summary' => '创建工作项。', + 'path' => '/organization/{organizationId}/workitems/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'title' => '标题', + 'description' => '工作项标题', + 'type' => 'string', + 'required' => true, + 'example' => '测试工作项', + ], + 'description' => [ + 'title' => '工作项内容', + 'description' => '工作项内容', + 'type' => 'string', + 'required' => false, + 'example' => '测试内容', + ], + 'descriptionFormat' => [ + 'title' => '内容格式', + 'description' => '内容格式，支持RICHTEXT和MARKDOWN格式，默认为RICHTEXT', + 'type' => 'string', + 'required' => false, + 'example' => 'RICHTEXT', + ], + 'assignedTo' => [ + 'title' => '工作项负责人的account id，或者企业中的用户名', + 'description' => '工作项负责人的id，或者企业中的用户名', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'space' => [ + 'title' => '项目id', + 'description' => '项目ID唯一标识，同projectId', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '同space字段，项目ID唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'spaceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + 'category' => [ + 'title' => '工作项的类型id，比如：Bug、Task对应id', + 'description' => '工作项的类型id，比如：Bug、Task对应id', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + 'workitemType' => [ + 'title' => '工作项小类型id', + 'description' => '工作项小类型id', + 'type' => 'string', + 'required' => true, + 'example' => '9uyxxxxxre573f561dxxn40', + ], + 'fieldValueList' => [ + 'title' => '自定义字段', + 'description' => '自定义字段', + 'type' => 'array', + 'items' => [ + 'description' => '需要先通过获取工作项字段的接口：ListWorkItemAllFields 查看哪些字段是必填，isRequired为true的则为必填。'."\n" + .'【优先级】，虽然是自定义字段，但是必填'."\n", + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '字段唯一标识，优先级字段必填', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'title' => '字段值，写入时使用', + 'description' => '字段值，写入时使用。优先级字段必填', + 'type' => 'string', + 'required' => false, + 'example' => '77c7fb03c4186c8691d6...', + ], + 'workitemIdentifier' => [ + 'title' => '工作项的唯一标识', + 'description' => '工作项的唯一标识，暂用不到', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'sprint' => [ + 'title' => '要关联迭代', + 'description' => '要关联迭代', + 'type' => 'array', + 'items' => [ + 'description' => '迭代唯一标识id', + 'type' => 'string', + 'required' => false, + 'example' => '81be62xxxxxb63e291bdcxxxxa4', + ], + 'required' => false, + ], + 'tracker' => [ + 'title' => '抄送人account id列表', + 'description' => '抄送人account id', + 'type' => 'array', + 'items' => [ + 'description' => '抄送人account id', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'participant' => [ + 'title' => '参与人account id列表，或者企业名称列表', + 'description' => '参与人account id', + 'type' => 'array', + 'items' => [ + 'description' => '参与人account id', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'verifier' => [ + 'title' => '验证者account id列表，或者企业名称列表', + 'description' => '验证者的account id', + 'type' => 'array', + 'items' => [ + 'description' => '验证者的account id', + 'type' => 'string', + 'required' => false, + 'example' => '1561159309......', + ], + 'required' => false, + ], + 'parent' => [ + 'title' => '所属父工作项的唯一标识', + 'description' => '父项工作项唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '3a0c9cdd24ae1e1995b8...', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + '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' => '负责人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '状态阶段id', + 'type' => 'string', + 'example' => '100005', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '所属项目id', + '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' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '父工作项id', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + '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' => '创建人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态唯一标识id', + 'description' => '状态唯一标识id', + 'type' => 'string', + 'example' => '28', + ], + 'sprintIdentifier' => [ + 'title' => '迭代的id', + 'description' => '迭代的唯一标识id', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + 'documentFormat' => [ + 'description' => '描述内容的格式，RICHTEXT 或者是 MARKDOWN', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"100005\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"28\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\",\\n \\"documentFormat\\": \\"RICHTEXT\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建工作项', + ], + 'CreateWorkitemComment' => [ + 'summary' => '创建工作项评论。', + 'path' => '/organization/{organizationId}/workitems/comment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60811b5eed6e867404f6xxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'title' => '评论内容', + 'description' => '评论内容', + 'type' => 'string', + 'required' => true, + 'example' => '有关于黑龙江地区旅店业室内广告屏出租', + ], + 'workitemIdentifier' => [ + 'title' => '', + 'description' => '工作项id，同workItemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f12xxxxxf9286ef5', + ], + 'formatType' => [ + 'title' => '目前支持RICHTEXT/MARKDOWN 二选一', + 'description' => '目前支持RICHTEXT/MARKDOWN 二选一', + 'type' => 'string', + 'required' => true, + 'example' => 'RICHTEXT/MARKDOWN', + ], + 'parentId' => [ + 'description' => '父目录ID。'."\n" + ."\n" + .'> 根目录时传**0**。', + 'type' => 'string', + 'required' => false, + 'example' => '26842', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => '调用是否成功。', + 'type' => 'string', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'Comment' => [ + 'description' => '审核备注。最长支持512字节。', + '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' => '阿里云id', + 'type' => 'string', + 'example' => '13164xxxxx41068', + ], + 'identifier' => [ + 'description' => '用户identifier', + 'type' => 'string', + 'example' => '1e9903d8bxxxxxxe9df9286ef5', + ], + 'realName' => [ + 'description' => '实际名', + 'type' => 'string', + 'example' => '王五', + ], + 'nickName' => [ + 'description' => '昵称', + 'type' => 'string', + 'example' => '王五', + ], + 'avatar' => [ + 'description' => '头像链接', + 'type' => 'string', + 'example' => 'https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'displayName' => [ + 'description' => '展示名字', + 'type' => 'string', + 'example' => '王五', + ], + 'targetType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'workitem', + ], + ], + ], + 'targetType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '资源id，也就是项目id', + 'type' => 'string', + 'example' => '79d523806bdxxxxx95612a5154', + ], + 'parentId' => [ + 'description' => '父工作流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26842', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667202662000', + ], + 'modifiedTime' => [ + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637995553000', + ], + 'isTop' => [ + 'title' => '是否置顶', + 'description' => '是否置顶', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'topTime' => [ + 'title' => '置顶时间', + 'description' => '置顶时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667202662000', + ], + 'formatType' => [ + 'title' => '评论类型', + 'description' => '评论类型', + 'type' => 'string', + 'example' => 'RICHTEXT/MARKDOWN ', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true 接口调用成功，false 接口调用失败\\",\\n \\"Comment\\": {\\n \\"Id\\": 26842,\\n \\"content\\": \\"有关于黑龙江地区旅店业室内广告屏出租\\",\\n \\"user\\": {\\n \\"account\\": \\"13164xxxxx41068\\",\\n \\"identifier\\": \\"1e9903d8bxxxxxxe9df9286ef5\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"displayName\\": \\"王五\\",\\n \\"targetType\\": \\"workitem\\"\\n },\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"79d523806bdxxxxx95612a5154\\",\\n \\"parentId\\": 26842,\\n \\"createTime\\": 1667202662000,\\n \\"modifiedTime\\": 1637995553000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667202662000,\\n \\"formatType\\": \\"RICHTEXT/MARKDOWN \\"\\n }\\n}","type":"json"}]', + 'title' => '创建工作项评论', + 'description' => '创建工作项目的评论。', + ], + 'DeleteWorkitemComment' => [ + 'summary' => '删除工作项下单个评论。', + 'path' => '/organization/{organizationId}/workitems/deleteComent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '工作项唯一标识id，同workitemId，workitemIdentifier', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'commentId' => [ + 'description' => '评论ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12xx34', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => 'true接口调用成功，false接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'title' => '是否删除成功', + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + 'title' => '删除当前工作项当前评论', + 'description' => '删除工作项下的单个评论。', + ], + 'DeleteWorkitemAllComment' => [ + 'summary' => '删除当前工作项所有评论。', + 'path' => '/organization/{organizationId}/workitems/deleteAllComment', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemId，workitemIdentifier，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A7586FEB-E48D-5579-983F-74981FBFF627', + ], + 'errorMsg' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'description' => 'true删除成功，false删除失败', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7586FEB-E48D-5579-983F-74981FBFF627\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + 'title' => '删除当前工作项所有评论', + 'description' => '删除当前工作项所有评论。', + ], + 'UpdateWorkitemComment' => [ + 'summary' => '更新工作项评论。', + 'path' => '/organization/{organizationId}/workitems/commentUpdate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'title' => '工作项内容', + 'description' => '评论内容', + 'type' => 'string', + 'required' => true, + 'example' => '这是更新后的评论内容', + ], + 'formatType' => [ + 'title' => '内容格式 目前支持MARKDOWN/RICHTEXT', + 'description' => '内容格式 目前支持MARKDOWN/RICHTEXT', + 'type' => 'string', + 'required' => true, + 'example' => 'MARKDOWN/RICHTEXT', + ], + 'workitemIdentifier' => [ + 'title' => '工作项id'."\n", + 'description' => '工作项id，同workitemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'commentId' => [ + 'title' => '工作项id'."\n", + 'description' => '评论id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1964584', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'InvalidParam.NotFound', + ], + 'success' => [ + 'description' => 'true或者false', + 'type' => 'string', + 'example' => 'true', + ], + 'comment' => [ + 'description' => '评论', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '评论唯一id'."\n", + 'description' => '评论唯一id'."\n", + 'type' => 'string', + 'example' => '1964584', + ], + 'content' => [ + 'description' => '评论内容', + 'type' => 'string', + 'example' => '这是更新后的评论内容', + ], + 'targetType' => [ + 'description' => '所属资源类型', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '资源id，工作项目id', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'parentId' => [ + 'description' => '父任务id', + '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' => '用户id', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'realName' => [ + 'description' => '用户真实姓名', + 'type' => 'string', + 'example' => '王五', + ], + 'nickName' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => '王五', + ], + 'avatar' => [ + 'description' => '用户头像', + 'type' => 'string', + 'example' => 'https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200', + ], + 'displayName' => [ + 'description' => '展示名称', + 'type' => 'string', + 'example' => '王五', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidParam.NotFound\\",\\n \\"success\\": \\"true\\",\\n \\"comment\\": {\\n \\"id\\": \\"1964584\\",\\n \\"content\\": \\"这是更新后的评论内容\\",\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"parentId\\": 2684432,\\n \\"createTime\\": 1667205617061,\\n \\"modifiedTime\\": 1646323200000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667205617089,\\n \\"formatType\\": \\"MARKDOWN/RICHTEXT\\",\\n \\"user\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"displayName\\": \\"王五\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '更新工作项评论', + 'description' => '更新工作项评论。', + ], + 'UpdateWorkItem' => [ + 'summary' => '更新工作项信息。', + 'path' => '/organization/{organizationId}/workitems/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '更新的信息', + 'description' => '更新的信息', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'title' => '更新的字段名', + 'description' => '要更新的字段identifier，可以从ListWorkItemAllFields获取。当值设置为description时，fieldType可以设置描述的格式，默认是RICHTEXT，支持RICHTEXT和MARKDOWN', + 'type' => 'string', + 'required' => true, + 'example' => 'subject', + ], + 'propertyValue' => [ + 'title' => '更新后的值', + 'description' => '更新后的值', + 'type' => 'string', + 'required' => true, + 'example' => 'newValue', + ], + 'identifier' => [ + 'title' => '工作项唯一标识id', + 'description' => '工作项id，同workitemIdentifier，workitemId字段，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'fieldType' => [ + 'title' => '更新字段的类型，标题：subject/自定义字段：customField/状态：status/描述：document/基本字段：basic(包括负责人、迭代、参与人等)', + 'description' => '更新字段的类型，subject代表修改标题; status代表修改是状态字段 ；document代表的是修改描述字段；user代表的是修改用户类型字段（包括负责人、参与人等用户类型的字段）；customField代表的是自定义字段 ；其中user对应的propertykey对应有三种workitem.tracke/ ak.issue.member/assignedTo ; customField字段类型中property值需要通过ListWorkItemAllFields来获取type类型为customField对应的identifier，其余的propertykey和Fieldtype是一样的。'."\n" + .'当propertyKey为description时，该值可以设置对应描述的格式，支持RICHTEXT和MARKDOWN', + 'type' => 'string', + 'required' => true, + 'example' => 'subject', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '工作项请求结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + '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' => [ + 'description' => '描述内容的格式，RICHTEXT 或者是 MARKDOWN', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '负责人', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '状态阶段id', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '所属项目id', + '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' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '父工作项id', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + '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' => '状态id', + 'type' => 'string', + 'example' => '111000', + ], + 'sprintIdentifier' => [ + 'title' => '迭代id', + 'description' => '迭代id', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"documentFormat\\": \\"RICHTEXT\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ACFS-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"111000\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateWorkItemResponse>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n <workitem>\\n <identifier>6fc04b35d8cb62128b55......</identifier>\\n <statusStageIdentifier>1</statusStageIdentifier>\\n <gmtModified>1645078744000</gmtModified>\\n <creator>1967043931......</creator>\\n <serialNumber>AVDC-2</serialNumber>\\n <spaceType>Project</spaceType>\\n <subject>testSubject</subject>\\n <document><p style=\\"text-align: left;text-indent: 0;margin-left: 0;\\"><span></span></p></document>\\n <modifier>1967043931......</modifier>\\n <spaceIdentifier>8fb83debd69a6c7c6626......</spaceIdentifier>\\n <workitemTypeIdentifier>9uy29901re573f561d......</workitemTypeIdentifier>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <gmtCreate>1644572109000</gmtCreate>\\n <assignedTo>1967043931......</assignedTo>\\n <spaceName>111122222233</spaceName>\\n <logicalStatus>NORMAL</logicalStatus>\\n <statusIdentifier>100005</statusIdentifier>\\n <status>待处理</status>\\n <sprintIdentifier>75528f17703e92e5a568......</sprintIdentifier>\\n </workitem>\\n</UpdateWorkItemResponse>","errorExample":""}]', + 'title' => '更新工作项信息', + ], + 'GetWorkitemAttachmentCreatemeta' => [ + 'summary' => '获取工作项附件上传的信息接口，这是工作项上传附件中的第一步。整个过程需要完成三步，'."\n" + .'第一步，调用该接口获取工作项的上传信息。'."\n" + .'第二步，根据该接口的返回信息将文件上传到oss中。'."\n" + .'第三步，将文件作为工作项的附件，对应的接口为 WorkitemAttachmentCreate(关联文件为工作项的附件)'."\n" + ."\n" + .'第二步上传文件时可以参考oss的文档：https://help.aliyun.com/document_detail/31926.html，'."\n" + .'注意请求为POST方法，数据是表单提交的方式。', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/attachment/createmeta', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60de7a6852743a5162b5f957', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '工作项id，同workItemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要上传的文件完整名称', + 'type' => 'string', + 'required' => true, + 'example' => 'application.jar', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'errorMessage' => [ + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => 'Forbidden.UserNotInCurrentOrganization', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'uploadInfo' => [ + 'description' => '可参考OSS的文档：https://help.aliyun.com/document_detail/31926.html', + 'type' => 'object', + 'properties' => [ + 'accessid' => [ + 'description' => '上传的认证信息，设置到上传时的OSSAccessKeyId', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + 'policy' => [ + 'description' => '上传的认证信息', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + 'signature' => [ + 'description' => '上传的认证信息', + 'type' => 'string', + 'example' => 'xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=', + ], + 'dir' => [ + 'description' => '上传的认证信息，对应到上传时为key', + 'type' => 'string', + 'example' => 'ddd/dddd', + ], + 'host' => [ + 'description' => '上传文件的地址', + 'type' => 'string', + 'example' => 'xxxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"errorMessage\\": \\"Forbidden.UserNotInCurrentOrganization\\",\\n \\"success\\": \\"true\\",\\n \\"uploadInfo\\": {\\n \\"accessid\\": \\"xxxxxxx\\",\\n \\"policy\\": \\"xxxxxxx\\",\\n \\"signature\\": \\"xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=\\",\\n \\"dir\\": \\"ddd/dddd\\",\\n \\"host\\": \\"xxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => '获取工作项上传附件的信息', + 'description' => '第二步的调用示例：'."\n" + .'', + ], + 'GetWorkitemTimeTypeList' => [ + 'summary' => '获取工时类型列表。', + 'path' => '/organization/{organizationId}/workitems/type/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'Invalid.IdNotFound', + ], + 'success' => [ + 'description' => 'true 成功 false 失败', + 'type' => 'string', + 'example' => 'true', + ], + 'timeType' => [ + 'description' => '时间类型', + 'type' => 'array', + 'items' => [ + 'description' => '时间类型', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '工时类型标识符', + 'type' => 'string', + 'example' => '67fb001005aac8d3d2a3372416', + ], + 'name' => [ + 'description' => '状态名', + 'type' => 'string', + ], + 'displayName' => [ + 'description' => '展示名称', + 'type' => 'string', + 'example' => 'deploy', + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '描述文案', + ], + 'position' => [ + 'description' => '展示位置', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Invalid.IdNotFound\\",\\n \\"success\\": \\"true\\",\\n \\"timeType\\": [\\n {\\n \\"identifier\\": \\"67fb001005aac8d3d2a3372416\\",\\n \\"name\\": \\"\\",\\n \\"displayName\\": \\"deploy\\",\\n \\"description\\": \\"描述文案\\",\\n \\"position\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取工时类型列表', + 'description' => '获取工时类型列表。', + ], + 'GetWorkitemRelations' => [ + 'summary' => '获得工作项关联项。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getRelations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id'."\n", + 'description' => '企业id'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemidentifier，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '8876ad01xxxxx65d9710b2631', + ], + ], + [ + 'name' => 'relationType', + 'in' => 'query', + 'schema' => [ + 'title' => '一共有BLOCKING，BLOCKED，ASSOCIATED， DUPLICATED，SUB， PARENT，一共6个待选值，只会获得工作项类型的关系项', + 'description' => '一共有BLOCKING，BLOCKED，ASSOCIATED， DUPLICATED，SUB， PARENT，一共6个待选值，只会获得工作项类型的关系项', + 'type' => 'string', + 'required' => true, + '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 of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => 'InvalidGroup.IdNotFound', + ], + 'success' => [ + 'description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'relationList' => [ + 'description' => '置顶关联项信息', + 'type' => 'array', + 'items' => [ + 'description' => '工作项信息', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '工作项id', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'subject' => [ + 'description' => '工作项标题', + 'type' => 'string', + 'example' => '标题内容', + ], + 'assignedTo' => [ + 'description' => '负责人aliyunPk', + 'type' => 'string', + 'example' => ' aliyun_1384605', + ], + 'spaceIdentifier' => [ + 'description' => '所属项目id', + 'type' => 'string', + 'example' => '2b856dxxxxxxb61d93676255ba', + ], + 'categoryIdentifier' => [ + 'description' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'workitemTypeIdentifier' => [ + 'description' => '工作项类型id', + 'type' => 'string', + 'example' => '9uy29901re573f561d69jn40', + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1667205617061', + ], + 'gmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '1667205617089', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"relationList\\": [\\n {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"subject\\": \\"标题内容\\",\\n \\"assignedTo\\": \\" aliyun_1384605\\",\\n \\"spaceIdentifier\\": \\"2b856dxxxxxxb61d93676255ba\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"workitemTypeIdentifier\\": \\"9uy29901re573f561d69jn40\\",\\n \\"gmtCreate\\": \\"1667205617061\\",\\n \\"gmtModified\\": \\"1667205617089\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获得工作项关联项', + 'description' => '获得工作项关联项。', + ], + 'GetWorkitemCommentList' => [ + 'summary' => '获得工作项的评论列表。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/commentList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业号', + 'description' => '企业号', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id'."\n", + 'description' => '工作项id，同workitemIdentifier，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'ce2xxxx21580baxxxx633f13', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'commentList' => [ + 'description' => '评论列表', + 'type' => 'array', + 'items' => [ + 'description' => '评论列表', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '评论id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6573', + ], + 'content' => [ + 'description' => '评论内容', + 'type' => 'string', + 'example' => '066961', + ], + 'targetType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'workitem', + ], + 'targetIdentifier' => [ + 'description' => '资源id，也就是工作项id', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'parentId' => [ + 'description' => '父评论id', + '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' => [ + 'description' => '创建人对象', + 'type' => 'object', + 'properties' => [ + 'account' => [ + 'description' => '人员账户', + 'type' => 'string', + 'example' => 'null', + ], + 'identifier' => [ + 'description' => '人员唯一标识', + 'type' => 'string', + 'example' => '123xxxxxxx222', + ], + 'realName' => [ + 'description' => '人员真实姓名', + 'type' => 'string', + 'example' => '张三', + ], + 'nickName' => [ + 'description' => '人员昵称', + 'type' => 'string', + 'example' => '李四', + ], + 'avatar' => [ + 'description' => '图标', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": \\"true 接口调用成功，false 接口调用失败\\",\\n \\"commentList\\": [\\n {\\n \\"id\\": 6573,\\n \\"content\\": \\"066961\\",\\n \\"targetType\\": \\"workitem\\",\\n \\"targetIdentifier\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"parentId\\": 1013131897677566,\\n \\"createTime\\": 1667205617061,\\n \\"modifiedTime\\": 1646323200000,\\n \\"isTop\\": true,\\n \\"topTime\\": 1667205617089,\\n \\"formatType\\": \\"RICHTEXT/MARKDOWN\\",\\n \\"user\\": {\\n \\"account\\": \\"null\\",\\n \\"identifier\\": \\"123xxxxxxx222\\",\\n \\"realName\\": \\"张三\\",\\n \\"nickName\\": \\"李四\\",\\n \\"avatar\\": \\"null\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获得工作项的评论列表', + 'description' => '获得工作项目的评论列表。', + ], + 'CreateWorkitemEstimate' => [ + 'summary' => '创建预计工时接口，登记一个工作项预计花费工时信息。', + 'path' => '/organization/{organizationId}/workitems/estimate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemId', + 'type' => 'string', + 'required' => true, + 'example' => '1e9903d8b3f1xxxxxf9286ef5', + ], + 'spentTime' => [ + 'title' => '花费工时，最大为9999', + 'description' => '花费工时，最大为9999', + 'type' => 'string', + 'required' => true, + 'example' => '21', + ], + 'type' => [ + 'title' => '类型', + 'description' => '工时类型，通过获得工时类型接口来获取，值为每一个类型的identifier', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0'."\n", + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => '描述信息', + ], + 'recordUserIdentifier' => [ + 'title' => '登记人,为用户的aliyunPk', + 'description' => '登记人,为用户的aliyunPk', + 'type' => 'string', + 'required' => true, + 'example' => '1316458xxxxx41068', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'success' => [ + 'description' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true 接口调用成功，false 接口调用失败', + ], + 'WorkitemTimeEstimate' => [ + 'description' => '时间estimate', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '工时唯一标识', + 'type' => 'string', + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + 'workitemIdentifier' => [ + 'description' => '工作项id，唯一标识', + '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' => '用户id', + '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' => 'null 代表普通用户', + ], + 'nameEn' => [ + 'description' => '用户拼音', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'gender' => [ + 'description' => '性别', + 'type' => 'string', + 'example' => '保留字段', + ], + 'mobile' => [ + 'description' => '电话号码', + 'type' => 'string', + 'example' => '无效字段，保留', + ], + 'email' => [ + 'description' => '邮箱信息', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nickNamePinyin' => [ + 'description' => '昵称拼音', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'realNamePinyin' => [ + 'description' => '实际名称拼音', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayNickName' => [ + 'description' => '展示昵称', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayRealName' => [ + 'description' => '展示实际名称', + 'type' => 'string', + 'example' => 'wangwu', + ], + 'displayName' => [ + 'description' => '展示名称', + 'type' => 'string', + 'example' => '王五', + ], + 'dingTalkId' => [ + 'description' => '钉钉id', + 'type' => 'string', + 'example' => 'fdsad12xxx11'."\n", + ], + 'tbRoleId' => [ + 'description' => '角色id', + 'type' => 'string', + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'isDisabled' => [ + 'description' => '是否不可见', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"WorkitemTimeEstimate\\": {\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"workitemIdentifier\\": \\"1e9903d8b3f1xxxxxf9286ef5\\",\\n \\"spentTime\\": 11,\\n \\"type\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"description\\": \\"蜜雪冰城甜蜜蜜\\",\\n \\"recordUser\\": {\\n \\"account\\": \\"1316458xxxxx41068\\",\\n \\"identifier\\": \\"deafe5f33xxxxx6a259d8dafd\\",\\n \\"realName\\": \\"王五\\",\\n \\"nickName\\": \\"王五\\",\\n \\"avatar\\": \\"https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200\\",\\n \\"stamp\\": \\"null 代表普通用户\\",\\n \\"nameEn\\": \\"wangwu\\",\\n \\"gender\\": \\"保留字段\\",\\n \\"mobile\\": \\"无效字段，保留\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"nickNamePinyin\\": \\"wangwu\\",\\n \\"realNamePinyin\\": \\"wangwu\\",\\n \\"displayNickName\\": \\"wangwu\\",\\n \\"displayRealName\\": \\"wangwu\\",\\n \\"displayName\\": \\"王五\\",\\n \\"dingTalkId\\": \\"fdsad12xxx11\\\\n\\",\\n \\"tbRoleId\\": \\"9144ef6b72d8exxxxx9e61a4d0\\",\\n \\"isDisabled\\": true\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建工作项预计工时接口', + 'description' => '创建预计工时接口。', + ], + 'GetCustomFieldOption' => [ + 'summary' => '获取字段自定义选项。', + 'path' => '/organization/{organizationId}/fields/{fieldId}/getCustomOption', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同projectId，项目唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '类型', + 'description' => '资源类型，目前默认为Project', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id，可以从ListProjectWorkitemTypes接口获取，对应identifier字段。', + 'type' => 'string', + 'required' => true, + 'example' => '9uyxxxx1re573f561dxxxxx', + ], + ], + [ + 'name' => 'fieldId', + 'in' => 'path', + 'schema' => [ + 'title' => '字段id', + 'description' => '字段id', + 'type' => 'string', + 'required' => true, + 'example' => '1019xxxxx5f5c33xxxxx9920d44', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fileds' => [ + 'title' => '字段值信息', + 'description' => '字段值信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'displayValue' => [ + 'title' => '展示的值', + 'description' => '展示的值', + 'type' => 'string', + 'example' => '223', + ], + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '字段唯一标识', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'identifier' => [ + 'title' => '迭代唯一标识符', + 'description' => '迭代唯一标识符', + 'type' => 'string', + 'example' => '3345', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅', + 'description' => '展示级别，数字范围1~9，数字越大，颜色越浅', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'position' => [ + 'title' => '待选值顺序', + 'description' => '待选值顺序', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'value' => [ + 'title' => '字段中文名称', + 'description' => '字段中文名称', + 'type' => 'string', + 'example' => '223', + ], + 'valueEn' => [ + 'title' => '字段英文名称', + 'description' => '字段英文名称', + 'type' => 'string', + 'example' => '223', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fileds\\": [\\n {\\n \\"displayValue\\": \\"223\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"identifier\\": \\"3345\\",\\n \\"level\\": 1,\\n \\"position\\": 1,\\n \\"value\\": \\"223\\",\\n \\"valueEn\\": \\"223\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetCustomFieldOptionResponse>\\n <fileds>\\n <displayValue>紧急</displayValue>\\n <identifier>ec6b0daec1334292f636......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Urgent</valueEn>\\n <level>0</level>\\n <position>1</position>\\n <value>紧急</value>\\n </fileds>\\n <fileds>\\n <displayValue>高</displayValue>\\n <identifier>0ff8f91ced4ee913da7......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>High</valueEn>\\n <level>1</level>\\n <position>2</position>\\n <value>高</value>\\n </fileds>\\n <fileds>\\n <displayValue>中</displayValue>\\n <identifier>77c7fb03c4186c8691d6......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Medium</valueEn>\\n <level>4</level>\\n <position>3</position>\\n <value>中</value>\\n </fileds>\\n <fileds>\\n <displayValue>低</displayValue>\\n <identifier>39a7dc21e2552dff2304......</identifier>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <valueEn>Low</valueEn>\\n <level>9</level>\\n <position>4</position>\\n <value>低</value>\\n </fileds>\\n <requestId>76FE0461-3F2C-53D4-9833-96CA49......</requestId>\\n <success>true</success>\\n <errorCode/>\\n <errorMsg/>\\n</GetCustomFieldOptionResponse>","errorExample":""}]', + 'title' => '获取字段自定义选项', + ], + 'GetWorkItemActivity' => [ + 'summary' => '查询工作项动态信息。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getActivity', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemIdentifier，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'activities' => [ + 'title' => '动态信息', + 'description' => '动态信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'eventType' => [ + 'title' => '事件类型', + 'description' => '事件类型', + 'type' => 'string', + 'example' => 'workitem.updated', + ], + 'actionType' => [ + 'title' => '动作类型', + 'description' => '动作类型', + 'type' => 'string', + 'example' => 'update', + ], + 'eventTime' => [ + 'title' => '事件时间', + 'description' => '事件时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640867079624', + ], + 'resourceIdentifier' => [ + 'title' => '操作对象', + 'description' => '操作对象', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'operator' => [ + 'title' => '操作者', + 'description' => '操作者', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'eventId' => [ + 'title' => '事件id', + 'description' => '事件id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3201131', + ], + 'parentEventId' => [ + 'title' => '父事件id', + 'description' => '父事件id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3201132', + ], + 'property' => [ + 'title' => '修改属性', + 'description' => '修改属性', + 'type' => 'object', + 'properties' => [ + 'propertyName' => [ + 'title' => '属性key', + 'description' => '属性key', + 'type' => 'string', + 'example' => 'subject', + ], + 'propertyType' => [ + 'title' => '类型', + 'description' => '类型', + 'type' => 'string', + 'example' => 'null', + ], + 'propertyIdentifier' => [ + 'title' => '资源id', + 'description' => '资源id', + 'type' => 'string', + 'example' => 'subject', + ], + 'displayName' => [ + 'title' => '属性的展示名', + 'description' => '属性的展示名', + 'type' => 'string', + 'example' => '标题', + ], + ], + 'example' => 'public', + ], + 'oldValue' => [ + 'description' => '更新前的值', + 'type' => 'array', + 'items' => [ + 'description' => '值实体', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => '修改值的类型，同propertyName', + 'type' => 'string', + 'example' => 'Sprint', + ], + 'plainValue' => [ + 'description' => '旧值', + 'type' => 'string', + 'example' => 'bed1cca179badeb501a72d1194', + ], + 'displayValue' => [ + 'description' => '旧值的显示值', + 'type' => 'string', + 'example' => 'Sprint-221124', + ], + ], + ], + ], + 'newValue' => [ + 'description' => '更新后的值', + 'type' => 'array', + 'items' => [ + 'description' => '值实体', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => '修改值的类型，同propertyName', + 'type' => 'string', + 'example' => 'Sprint', + ], + 'plainValue' => [ + 'description' => '新值', + 'type' => 'string', + 'example' => 'bed1cca179badeb501a72d1194', + ], + 'displayValue' => [ + 'description' => '新值的显示值', + 'type' => 'string', + 'example' => 'Sprint-221124', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"activities\\": [\\n {\\n \\"eventType\\": \\"workitem.updated\\",\\n \\"actionType\\": \\"update\\",\\n \\"eventTime\\": 1640867079624,\\n \\"resourceIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"operator\\": \\"19xx7043xxxxxxx914\\",\\n \\"eventId\\": 3201131,\\n \\"parentEventId\\": 3201132,\\n \\"property\\": {\\n \\"propertyName\\": \\"subject\\",\\n \\"propertyType\\": \\"null\\",\\n \\"propertyIdentifier\\": \\"subject\\",\\n \\"displayName\\": \\"标题\\"\\n },\\n \\"oldValue\\": [\\n {\\n \\"resourceType\\": \\"Sprint\\",\\n \\"plainValue\\": \\"bed1cca179badeb501a72d1194\\",\\n \\"displayValue\\": \\"Sprint-221124\\"\\n }\\n ],\\n \\"newValue\\": [\\n {\\n \\"resourceType\\": \\"Sprint\\",\\n \\"plainValue\\": \\"bed1cca179badeb501a72d1194\\",\\n \\"displayValue\\": \\"Sprint-221124\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetWorkItemActivityResponse>\\n <requestId>ASSDS-ASSASX-XSAXSA-XSAXSAXS</requestId>\\n <errorMsg>error</errorMsg>\\n <errorCode>Openapi.RequestError</errorCode>\\n <success>true</success>\\n <activities>\\n <eventType>workitem.updated</eventType>\\n <actionType>update</actionType>\\n <eventTime>1640867079624</eventTime>\\n <resourceIdentifier>e8bxxxxxxxxxxxxxxxx23</resourceIdentifier>\\n <operator>19xx7043xxxxxxx914</operator>\\n <eventId>3201131</eventId>\\n <parentEventId>3201132</parentEventId>\\n <property>\\n <propertyName>subject</propertyName>\\n <propertyType>null</propertyType>\\n <propertyIdentifier>subject</propertyIdentifier>\\n <displayName>标题</displayName>\\n </property>\\n </activities>\\n</GetWorkItemActivityResponse>","errorExample":""}]', + 'title' => '查询工作项动态', + ], + 'GetWorkItemInfo' => [ + 'summary' => '获取工作项的基本信息。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118506', + 'abilityTreeNodes' => [ + 'FEATURErdcY249FB', + ], + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organizatio', + 'type' => 'string', + 'required' => true, + 'example' => '5e706xxxxxx01xxx96', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemIdentifier字段，工作项唯一标识，可以在获取工作项列表的接口ListWorkItems中获取', + 'type' => 'string', + 'required' => true, + 'example' => 'ce2xxxx21580baxxxx633f13', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '工作项请求结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + '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' => [ + 'description' => '工作项内容格式，支持RICHTEXT和MARKDOWN', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + 'assignedTo' => [ + 'title' => '负责人', + 'description' => '负责人', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '状态阶段id', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '所属项目id', + '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' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '父工作项id', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + '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' => '创建人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '状态id', + 'type' => 'string', + 'example' => '例：100005', + ], + 'sprint' => [ + 'title' => '关联的迭代id', + 'description' => '关联的迭代id', + 'type' => 'array', + 'items' => [ + 'description' => '迭代唯一标识', + 'type' => 'string', + 'example' => '81be626abf9b63e291bd......', + ], + ], + 'tag' => [ + 'title' => '标签id列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => [ + 'description' => 'tag的唯一标识', + 'type' => 'string', + 'example' => 'c76e0e4bf64801cfad73......', + ], + ], + 'participant' => [ + 'title' => '参与人account id列表', + 'description' => '参与人account id列表', + 'type' => 'array', + 'items' => [ + 'description' => '参与人account id', + 'type' => 'string', + 'example' => '1561159309......', + ], + ], + 'tracker' => [ + 'title' => '抄送人的account id列表', + 'description' => '抄送人的account id列表', + 'type' => 'array', + 'items' => [ + 'description' => '抄送人的account id', + 'type' => 'string', + 'example' => '1561159309......', + ], + ], + 'verifier' => [ + 'title' => '验证者的account id列表', + 'description' => '验证者的account id列表', + 'type' => 'array', + 'items' => [ + 'description' => '验证者的account id', + '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' => '字段的className，便于数据查询', + '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' => '自定义字段值的position', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + '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' => '字段值为对象类型时，值所对应的对象的唯一标识例如：option表中的id', + 'type' => 'string', + 'example' => '2022-02-01 00:00:00', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'finishTime' => [ + 'description' => '完成时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699366778000', + ], + 'tagDetails' => [ + 'description' => '标签详情', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '标签唯一标识', + 'type' => 'string', + 'example' => '8d859b4fce9d86bc324a9cf00c', + ], + 'name' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => 'paymentcenter', + ], + 'color' => [ + 'description' => '标签颜色', + 'type' => 'string', + 'example' => '#1F9AEF', + ], + ], + ], + ], + 'versions' => [ + 'description' => '关联的版本', + 'type' => 'array', + 'items' => [ + 'description' => '版本', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '版本id', + 'type' => 'string', + 'example' => 'ec65ce5dbc84790b53c272cb43', + ], + 'name' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => 'UAT', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"documentFormat\\": \\"RICHTEXT\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"例：100005\\",\\n \\"sprint\\": [\\n \\"81be626abf9b63e291bd......\\"\\n ],\\n \\"tag\\": [\\n \\"c76e0e4bf64801cfad73......\\"\\n ],\\n \\"participant\\": [\\n \\"1561159309......\\"\\n ],\\n \\"tracker\\": [\\n \\"1561159309......\\"\\n ],\\n \\"verifier\\": [\\n \\"1561159309......\\"\\n ],\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"例：80\\",\\n \\"fieldFormat\\": \\"例：input\\",\\n \\"fieldClassName\\": \\"例如：date\\",\\n \\"objectValue\\": \\"null\\",\\n \\"value\\": \\"例：2022-01-06 00:00:00\\",\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"position\\": 1,\\n \\"level\\": 1,\\n \\"valueList\\": [\\n {\\n \\"value\\": \\"2022-02-01 00:00:00\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"2022-02-01 00:00:00\\",\\n \\"identifier\\": \\"2022-02-01 00:00:00\\",\\n \\"level\\": 1\\n }\\n ]\\n }\\n ],\\n \\"finishTime\\": 1699366778000,\\n \\"tagDetails\\": [\\n {\\n \\"identifier\\": \\"8d859b4fce9d86bc324a9cf00c\\",\\n \\"name\\": \\"paymentcenter\\",\\n \\"color\\": \\"#1F9AEF\\"\\n }\\n ],\\n \\"versions\\": [\\n {\\n \\"identifier\\": \\"ec65ce5dbc84790b53c272cb43\\",\\n \\"name\\": \\"UAT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetWorkItemInfoResponse>\\n <result>\\n <identifier>5daa9a15c7fd55523996......</identifier>\\n <subject>111000111</subject>\\n <document>test</document>\\n <assignedTo>1967043931......</assignedTo>\\n <status>待处理</status>\\n <statusIdentifier>100005</statusIdentifier>\\n <statusStageIdentifier>1</statusStageIdentifier>\\n <spaceIdentifier>8fb83debd69a6c7c6626......</spaceIdentifier>\\n <spaceName>111122222233</spaceName>\\n <spaceType>Project</spaceType>\\n <logicalStatus>NORMAL</logicalStatus>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <parentIdentifier/>\\n <workitemTypeIdentifier>9uy29901re573f561d......</workitemTypeIdentifier>\\n <updateStatusAt/>\\n <serialNumber>5</serialNumber>\\n <gmtCreate>1644896556000</gmtCreate>\\n <gmtModified>1645003986000</gmtModified>\\n <creator>1967043931947914</creator>\\n <modifier/>\\n <sprint>dd9742a1c2ee285acdb7......</sprint>\\n <tag>c76e0e4bf64801cfad7......</tag>\\n <participant>1561159309......</participant>\\n <participant>1847535819......</participant>\\n <tracker>1062519337......</tracker>\\n <tracker>1847535819......</tracker>\\n <customFields>\\n <fieldIdentifier>79</fieldIdentifier>\\n <fieldFormat>input</fieldFormat>\\n <fieldClassName>date</fieldClassName>\\n <valueList>\\n <value>2022-01-06 00:00:00</value>\\n <valueEn/>\\n <displayValue>2022-01-06 00:00:00</displayValue>\\n <identifier>2022-01-06 00:00:00</identifier>\\n <level/>\\n </valueList>\\n <objectValue/>\\n <value>2022-01-06 00:00:00</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n <customFields>\\n <fieldIdentifier>80</fieldIdentifier>\\n <fieldFormat>input</fieldFormat>\\n <fieldClassName>date</fieldClassName>\\n <valueList>\\n <value>2022-02-01 00:00:00</value>\\n <valueEn/>\\n <displayValue>2022-02-01 00:00:00</displayValue>\\n <identifier>2022-02-01 00:00:00</identifier>\\n <level/>\\n </valueList>\\n <objectValue/>\\n <value>2022-02-01 00:00:00</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n <customFields>\\n <fieldIdentifier>priority</fieldIdentifier>\\n <fieldFormat>list</fieldFormat>\\n <fieldClassName>option</fieldClassName>\\n <valueList>\\n <value>中</value>\\n <valueEn>Medium</valueEn>\\n <displayValue>中</displayValue>\\n <identifier>77c7fb03c4186c8691d6......</identifier>\\n <level>4</level>\\n </valueList>\\n <objectValue/>\\n <value>77c7fb03c4186c8691d6......</value>\\n <workitemIdentifier>5daa9a15c7fd55523996......</workitemIdentifier>\\n <position/>\\n <level/>\\n </customFields>\\n </result>\\n <errorMsg/>\\n <requestId/>\\n <errorCode/>\\n <success>true</success>\\n</GetWorkItemInfoResponse>","errorExample":""}]', + 'title' => '获取工作项基本信息', + ], + 'GetWorkItemWorkFlowInfo' => [ + 'summary' => '获取工作项工作流信息。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/getWorkflowInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:'."\n" + .'//devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'configurationId', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '对应工作项类型的工作流配置id，该值可以从页面接口请求：https:'."\n" + .'//devops.aliyun.com/projex/api/workitem/workitemType/setting/space/getSpaceWorkitemTypeScope?spaceType=Project&spaceIdentifier=c595d0c3df4c743ac811......&workitemTypeIdentifier=ba102e46bc6a8483...... 中获取。对应的字段值在result-> configurations-> 中configType为Workflow的identifier。', + 'type' => 'string', + 'required' => false, + 'example' => '711d33c738b9171c45fa......', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemIdentifier字段，工作项唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'fd0xxxxx00d355b05df60xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '工作项请求结果', + 'description' => '工作项请求结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + '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' => '工作流所属的团队空间或项目的identifier', + 'type' => 'string', + 'example' => 'e8b26xxxxx6e76aa20xxxxx23', + ], + 'ownerSpaceType' => [ + 'title' => '工作流所属的团队项目类型', + 'description' => '工作流所属的团队项目类型', + 'type' => 'string', + 'example' => 'null', + ], + 'defaultStatusIdentifier' => [ + 'title' => '工作流的默认状态', + 'description' => '工作流的默认状态id，具体的工作流列表在statuses状态列表里。', + 'type' => 'string', + 'example' => '100005', + ], + 'statusOrder' => [ + 'title' => '工作流的状态顺序', + 'description' => '工作流的状态顺序', + 'type' => 'string', + 'example' => 'null', + ], + 'resourceType' => [ + 'title' => '资源类型', + 'description' => '资源来源，项目工作流：Project、工作项工作流：Workitem', + 'type' => 'string', + 'example' => 'Project', + ], + 'source' => [ + 'title' => '工作流来源', + 'description' => '工作流来源，system系统自带的，organization企业配置的工作流，custom项目或者团队自定义', + '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' => '创建人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'workflowActions' => [ + 'title' => '工作流的流转步骤', + 'description' => '工作流的流转步骤', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '流转步骤的id', + 'description' => '流转步骤的id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16274887', + ], + 'name' => [ + 'title' => 'action的名称', + 'description' => 'action的名称', + 'type' => 'string', + 'example' => 'xxx', + ], + 'workflowIdentifier' => [ + 'title' => 'action对应的工作流', + 'description' => 'action对应的工作流', + 'type' => 'string', + 'example' => 'fd0xxxxxd00d355b05dxxxx26', + ], + 'workflowStatusIdentifier' => [ + 'title' => 'action对应的当前状态id', + 'description' => 'action对应的当前状态id', + 'type' => 'string', + 'example' => '100005', + ], + 'nextWorkflowStatusIdentifier' => [ + 'title' => 'action对应的下个状态的信息id', + 'description' => 'action对应的下个状态的信息id', + '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' => '状态来源，system：系统默认的、custom：企业/项目或者团队新建的', + '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' => '创建人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'xxx', + ], + 'resourceType' => [ + 'title' => '资源来源', + 'description' => '状态作用的资源类型，项目：Project、工作项：Workitem', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"workflow\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"name\\": \\"名称\\",\\n \\"description\\": \\"工作流的描述\\",\\n \\"ownerSpaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"ownerSpaceType\\": \\"null\\",\\n \\"defaultStatusIdentifier\\": \\"100005\\",\\n \\"statusOrder\\": \\"null\\",\\n \\"resourceType\\": \\"Project\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"workflowActions\\": [\\n {\\n \\"id\\": 16274887,\\n \\"name\\": \\"xxx\\",\\n \\"workflowIdentifier\\": \\"fd0xxxxxd00d355b05dxxxx26\\",\\n \\"workflowStatusIdentifier\\": \\"100005\\",\\n \\"nextWorkflowStatusIdentifier\\": \\"100011\\"\\n }\\n ],\\n \\"statuses\\": [\\n {\\n \\"identifier\\": \\"156603\\",\\n \\"name\\": \\"待处理\\",\\n \\"workflowStageName\\": \\"确认阶段\\",\\n \\"workflowStageIdentifier\\": \\"1\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1613805843000,\\n \\"gmtModified\\": 1613805843000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"resourceType\\": \\"Workitem\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取工作项工作流信息', + ], + 'ListProjectWorkitemTypes' => [ + 'summary' => '获取项目中的工作项类型。', + 'path' => '/organization/{organizationId}/projects/{projectId}/getWorkitemType', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同spaceIdentifier，项目唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '空间类型', + 'description' => '空间类型，这里填Project即可。', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型', + 'description' => '工作项类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'openapi平台的request id', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误返回码', + 'description' => '错误返回码', + 'type' => 'string', + 'example' => '例：Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误返回信息', + 'description' => '错误返回信息', + 'type' => 'string', + 'example' => 'errormessage', + ], + 'success' => [ + 'title' => '接口是否正常返回', + 'description' => '接口是否正常返回', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'workitemTypes' => [ + 'title' => '工作项类型', + 'description' => '工作项类型', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + 'type' => 'string', + 'example' => 'dfexxxxxf4fee18xxxxx36', + ], + 'name' => [ + 'title' => '工作项类型的名称', + 'description' => '工作项类型的名称', + 'type' => 'string', + 'example' => '例：业务类需求', + ], + 'nameEn' => [ + 'title' => '工作项类型的英文名称', + 'description' => '工作项类型的英文名称', + 'type' => 'string', + 'example' => '例：Business Requirement', + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型', + 'description' => '工作项类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk', + 'type' => 'string', + 'example' => 'Req', + ], + 'systemDefault' => [ + 'title' => '是否系统默认', + 'description' => '是否系统默认，true-系统默认/false-企业创建', + 'type' => 'boolean', + 'example' => 'true', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620455467000', + ], + 'creator' => [ + 'title' => '工作项类型创建人', + 'description' => '工作项类型创建人', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => '该类型的具体信息', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'defaultType' => [ + 'title' => '在项目中是否为默认类型', + 'description' => '在项目中是否为默认类型', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'gmtAdd' => [ + 'title' => '添加到项目中的时间', + 'description' => '添加到项目中的时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641870287000', + ], + 'addUser' => [ + 'title' => '添加到项目中的添加人', + 'description' => '添加到项目中的添加人', + 'type' => 'string', + 'example' => '用户阿里云pk，例如19xxxx31947xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"例：Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"workitemTypes\\": [\\n {\\n \\"identifier\\": \\"dfexxxxxf4fee18xxxxx36\\",\\n \\"name\\": \\"例：业务类需求\\",\\n \\"nameEn\\": \\"例：Business Requirement\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"systemDefault\\": true,\\n \\"gmtCreate\\": 1620455467000,\\n \\"creator\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"description\\": \\"该类型的具体信息\\",\\n \\"enable\\": true,\\n \\"defaultType\\": true,\\n \\"gmtAdd\\": 1641870287000,\\n \\"addUser\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectWorkitemTypesResponse>\\n <workitemTypes>\\n <systemDefault>true</systemDefault>\\n <identifier>9uy29901re573f561d......</identifier>\\n <creator>AK-ADMIN</creator>\\n <enable>true</enable>\\n <addUser>1967043931......</addUser>\\n <name>产品类需求</name>\\n <description/>\\n <nameEn>Requirement</nameEn>\\n <gmtAdd>1644551256000</gmtAdd>\\n <categoryIdentifier>Req</categoryIdentifier>\\n <gmtCreate>1613978186000</gmtCreate>\\n <defaultType>true</defaultType>\\n </workitemTypes>\\n <requestId>D8B2431B-7A35-5DD5-985D-C62192......</requestId>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n</ListProjectWorkitemTypesResponse>","errorExample":""}]', + 'title' => '获取工作项类型', + ], + 'ListWorkItemAllFields' => [ + 'summary' => '获取工作项字段列表。', + 'path' => '/organization/{organizationId}/workitems/fields/listAll', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + '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' => '项目唯一标识id，同projectId，项目唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型id，工作项类型的列表和id可以从ListProjectWorkitemType中获取', + 'description' => '工作项类型id，工作项类型的列表和ID可以从ListProjectWorkitemTypes中获取', + 'type' => 'string', + 'required' => true, + 'example' => 'dfexxxxxf4fee18xxxxx36', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fields' => [ + 'title' => '字段信息', + 'description' => '字段信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人阿里云accountId', + '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' => '区分不同的类型，如系统字段：NativeField，用户自定义字段：CustomField', + 'type' => 'string', + 'example' => 'NativeField', + ], + 'identifier' => [ + 'title' => '字段唯一标识符', + 'description' => '字段唯一标识符', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '字段名称', + 'description' => '字段名称', + 'type' => 'string', + 'example' => '负责人', + ], + 'format' => [ + 'title' => '字段格式', + 'description' => '字段格式', + 'type' => 'string', + 'example' => 'list', + ], + 'className' => [ + 'title' => '字段类型', + 'description' => '字段类型', + 'type' => 'string', + 'example' => '例：date', + ], + 'resourceType' => [ + 'title' => '区分不同的适用对象', + 'description' => '区分不同的适用对象', + 'type' => 'string', + 'example' => '例：Workitem', + ], + 'defaultValue' => [ + 'title' => '默认值', + 'description' => '默认值', + 'type' => 'string', + 'example' => '123', + ], + 'isRequired' => [ + 'title' => '是否必填', + 'description' => '是否必填', + 'type' => 'boolean', + 'example' => 'false', + ], + 'isSystemRequired' => [ + 'title' => '是否是系统必须字段，比如：负责人、状态等。', + 'description' => '是否是系统必须字段，比如：负责人、状态等。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'linkWithService' => [ + 'title' => '联动的服务，比如：迭代 迭代服务开启/关闭，这个字段字段加进/剔除出对应的模板； 字段模板里，这类字段不能手动添加或删除', + 'description' => '联动的服务，比如迭代，迭代服务开启/关闭，这个字段加进/剔除出对应的模板； 字段模板里，这类字段不能手动添加或删除', + 'type' => 'string', + 'example' => 'null', + ], + 'isShowWhenCreate' => [ + 'title' => '创建时是否展示', + 'description' => '创建时是否展示', + 'type' => 'boolean', + 'example' => 'false', + ], + 'options' => [ + 'title' => '待选值', + 'description' => '待选值', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '待选值的唯一标识', + 'description' => '待选值的唯一标识', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'fieldIdentifier' => [ + 'title' => '字段唯一标识', + 'description' => '字段唯一标识', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'value' => [ + 'title' => '待选值中文名称', + 'description' => '待选值中文名称', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'valueEn' => [ + 'title' => '待选值英文名称', + 'description' => '待选值英文名称', + 'type' => 'string', + 'example' => 'null', + ], + 'displayValue' => [ + 'title' => '根据语言环境获取当前展示的值', + 'description' => '根据语言环境获取当前展示的值', + 'type' => 'string', + 'example' => '重复的缺陷', + ], + 'position' => [ + 'title' => '待选值顺序', + 'description' => '待选值顺序', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'level' => [ + 'title' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'description' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fields\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"字段的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": \\"NativeField\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"负责人\\",\\n \\"format\\": \\"list\\",\\n \\"className\\": \\"例：date\\",\\n \\"resourceType\\": \\"例：Workitem\\",\\n \\"defaultValue\\": \\"123\\",\\n \\"isRequired\\": false,\\n \\"isSystemRequired\\": false,\\n \\"linkWithService\\": \\"null\\",\\n \\"isShowWhenCreate\\": false,\\n \\"options\\": [\\n {\\n \\"identifier\\": \\"重复的缺陷\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"value\\": \\"重复的缺陷\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"重复的缺陷\\",\\n \\"position\\": 1,\\n \\"level\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取工作项字段列表', + ], + 'ListWorkItemWorkFlowStatus' => [ + 'summary' => '获取工作项工作流状态列表。', + 'path' => '/organization/{organizationId}/workitems/workflow/listWorkflowStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如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' => 'workitemCategoryIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项大类型', + 'description' => '工作项大类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + [ + 'name' => 'workitemTypeIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项小类型id', + 'description' => '工作项小类型id，可以从ListProjectWorkitemTypes获取，对应字段为identifier。如果不填，则默认为默认工作流。', + 'type' => 'string', + 'required' => false, + 'example' => '例：5e7xxxxb3cd3711dd6xxx2c', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同projectId字段，项目唯一标识id', + 'type' => 'string', + 'required' => true, + 'example' => '例：5e70xxxxxxcd000xxxxe96', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'openapi平台的request id', + 'description' => '请求id，每次请求都是唯一值'."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'title' => '错误返回码', + 'description' => '错误返回码', + 'type' => 'string', + 'example' => '例：Openapi.RequestError', + ], + 'errorMessage' => [ + 'title' => '错误返回信息', + 'description' => '错误返回信息', + 'type' => 'string', + 'example' => 'errormessage', + ], + 'success' => [ + 'title' => '接口是否正常返回', + 'description' => '接口是否正常返回', + 'type' => 'boolean', + 'example' => 'true或者false', + ], + 'statuses' => [ + 'title' => '工作流状态', + 'description' => '工作流状态', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作流状态id', + 'description' => '工作流状态id', + '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' => '状态来源，system：系统默认的，custom:企业、项目或者团队新建的', + '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' => '状态作用的资源类型，项目：Project，工作项：Workitem', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"例：Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"statuses\\": [\\n {\\n \\"identifier\\": \\"dfexxxxxf4fee18xxxxx36\\",\\n \\"name\\": \\"例：待处理\\",\\n \\"workflowStageName\\": \\"例：确认阶段\\",\\n \\"workflowStageIdentifier\\": \\"例如：1\\",\\n \\"source\\": \\"system\\",\\n \\"gmtCreate\\": 1620455467000,\\n \\"creator\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"description\\": \\"该状态的具体信息\\",\\n \\"modifier\\": \\"用户阿里云pk，例如19xxxx31947xxxx\\",\\n \\"gmtModified\\": 1641870287000,\\n \\"resourceType\\": \\"Workitem\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListWorkItemWorkFlowStatusResponse>\\n <requestId>B40562D3-6200-5F51-8290-7568B7......</requestId>\\n <success>true</success>\\n <errorMessage/>\\n <errorCode/>\\n <statuses>\\n <identifier>100005</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>确认阶段</workflowStageName>\\n <name>待处理</name>\\n <description/>\\n <source>system</source>\\n <gmtCreate>1613805843000</gmtCreate>\\n <workflowStageIdentifier>1</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>156603</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>设计阶段</workflowStageName>\\n <name>设计中</name>\\n <source>system</source>\\n <gmtCreate>1615190250000</gmtCreate>\\n <workflowStageIdentifier>7</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>142838</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>开发阶段</workflowStageName>\\n <name>开发中</name>\\n <source>system</source>\\n <gmtCreate>1618991351000</gmtCreate>\\n <workflowStageIdentifier>11</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>100012</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>测试阶段</workflowStageName>\\n <name>测试中</name>\\n <source>system</source>\\n <gmtCreate>1618992049000</gmtCreate>\\n <workflowStageIdentifier>12</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>100014</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>正常结束</workflowStageName>\\n <name>已完成</name>\\n <source>system</source>\\n <gmtCreate>1613996161000</gmtCreate>\\n <workflowStageIdentifier>4</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n <statuses>\\n <identifier>141230</identifier>\\n <creator>AK-ADMIN</creator>\\n <workflowStageName>异常结束</workflowStageName>\\n <name>已取消</name>\\n <source>system</source>\\n <gmtCreate>1613996214000</gmtCreate>\\n <workflowStageIdentifier>5</workflowStageIdentifier>\\n <resourceType>Workitem</resourceType>\\n </statuses>\\n</ListWorkItemWorkFlowStatusResponse>","errorExample":""}]', + 'title' => '获取工作项工作流状态列表', + ], + 'ListWorkitems' => [ + 'summary' => '获取工作项列表。', + 'path' => '/organization/{organizationId}/listWorkitems', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n", + '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' => '项目id，同projectId，项目唯一标识id', + 'type' => 'string', + 'required' => true, + 'example' => '8fb83debd69a6c7c6626......', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk', + 'description' => '工作项大类型，需求为Req，缺陷为Bug，任务为Task，风险为Risk，原始诉求为Request，主题为Topic', + 'type' => 'string', + 'required' => true, + 'example' => 'Req', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '第一页值不需要填写，后面每一页的值需要从前一次调用结果中获取到此字段，然后获取后面的分页数据', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '每页最大返回数量，0-200，默认值20', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'conditions', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '过滤条件，可以参考页面上的工作项列表中请求workitem/list的搜索参数。'."\n" + .'注意：里面的人员id，要为阿里云accountID，即账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '{"conditionGroups":[]}', + ], + ], + [ + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => [ + 'title' => '额外条件', + 'description' => '额外条件，当该字段不为空时，conditions也不能为空', + 'type' => 'string', + 'required' => false, + 'example' => '{"conditionGroups":[]}', + ], + ], + [ + 'name' => 'groupCondition', + 'in' => 'query', + 'schema' => [ + 'title' => '分组条件', + 'description' => "\n" + .'分组条件，可以参考页面上的工作项列表中请求workitem/list的搜索参数。'."\n" + .'注意：里面的人员id，要为阿里云accountID，即账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"}', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '排序顺序，可以参考页面上的工作项列表中请求workitem/list的搜索参数。'."\n" + .'注意：里面的人员id，要为阿里云accountID，即账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldIdentifier":"status","format":"list","order":"desc","className":"status"}', + ], + ], + [ + 'name' => 'searchType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询类型', + 'description' => '搜索类型，默认是LIST，还可支持树形TREE等类型，具体更多参见页面请求的参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'LIST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '分页Token，没有下一页则为空', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitems' => [ + 'title' => '工作项信息', + 'description' => '工作项信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '工作项唯一标识', + 'description' => '工作项唯一标识', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '工作项标题', + 'description' => '工作项标题', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'document' => [ + 'title' => '工作项内容', + 'description' => '工作项内容，已废弃，请调用获取详情接口获取', + 'type' => 'string', + 'example' => 'xxx', + ], + 'assignedTo' => [ + 'title' => '负责人aliyunPk', + 'description' => '负责人的阿里云accountID', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id', + 'description' => '状态阶段id', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '所属项目id', + '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' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '父工作项id', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + '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' => '创建人的阿里云accountID', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'modifier' => [ + 'title' => '修改人aliyunPK', + 'description' => '修改人的阿里云accountID', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'statusIdentifier' => [ + 'title' => '状态唯一标识', + 'description' => '状态唯一标识', + 'type' => 'string', + 'example' => '100005', + ], + 'sprintIdentifier' => [ + 'title' => '迭代id', + 'description' => '迭代id', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + 'finishTime' => [ + 'description' => '完成时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699366778000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitems\\": [\\n {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"xxx\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"ABCD-1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"100005\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\",\\n \\"finishTime\\": 1699366778000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取工作项列表', + ], + 'ListWorkitemTime' => [ + 'summary' => '获取工作项工时明细列表。', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/time/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项唯一标识', + 'description' => '工作项id，同workitemIdentifier字段，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '5daa9a15c7fd55523996......', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitemTime' => [ + 'title' => '工时信息', + 'description' => '工时信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，唯一标识', + 'description' => '工作项id，唯一标识', + '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' => '登记人的account Id', + 'type' => 'string', + 'example' => '1967043931......', + ], + 'gmtCreate' => [ + 'title' => '工时记录的创建时间', + 'description' => '工时记录的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtModified' => [ + 'title' => '工时记录的修改时间', + 'description' => '工时记录的修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + ], + ], + ], + 'code' => [ + 'title' => '接口返回code', + 'description' => '接口返回code', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitemTime\\": [\\n {\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"identifier\\": \\"a4ac3a81e90217db32b7......\\",\\n \\"gmtStart\\": 1653235200000,\\n \\"gmtEnd\\": 1653235200000,\\n \\"actualTime\\": 1,\\n \\"type\\": \\"研发\\",\\n \\"description\\": \\"开发代码等\\",\\n \\"recordUser\\": \\"1967043931......\\",\\n \\"gmtCreate\\": 1653235200000,\\n \\"gmtModified\\": 1653235200000\\n }\\n ],\\n \\"code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListWorkitemTimeResponse>\\n <code>200</code>\\n <success>true</success>\\n <errorCode>success</errorCode>\\n <workitemTime>\\n <actualTime>3</actualTime>\\n <identifier>a4ac3a81e90217db32b7......</identifier>\\n <recordUser>1967043931......</recordUser>\\n <gmtModified>1653304358000</gmtModified>\\n <workitemIdentifier>9eb0f6ab3dfb3d23b40f......</workitemIdentifier>\\n <gmtEnd>1653235200000</gmtEnd>\\n <type>研发</type>\\n <gmtCreate>1653304358000</gmtCreate>\\n <gmtStart>1653235200000</gmtStart>\\n </workitemTime>\\n <workitemTime>\\n <actualTime>4</actualTime>\\n <identifier>9f1e959e2109d71baaa7......</identifier>\\n <recordUser>1967043931......</recordUser>\\n <gmtModified>1653304358000</gmtModified>\\n <workitemIdentifier>9eb0f6ab3dfb3d23b40f......</workitemIdentifier>\\n <gmtEnd>1653235200000</gmtEnd>\\n <description>test</description>\\n <type>测试</type>\\n <gmtCreate>1653304364000</gmtCreate>\\n <gmtStart>1653235200000</gmtStart>\\n </workitemTime>\\n <errorMsg/>\\n</ListWorkitemTimeResponse>","errorExample":""}]', + 'title' => '获取工作项工时明细列表', + ], + 'ListWorkitemEstimate' => [ + 'summary' => '获取工作项预计工时登记列表', + 'path' => '/organization/{organizationId}/workitems/{workitemId}/estimate/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'workitemId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作项唯一标识', + 'description' => '工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '5daa9a15c7fd55523996......', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workitemTimeEstimate' => [ + 'title' => '工时信息', + 'description' => '工时信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，唯一标识', + 'description' => '工作项id，唯一标识', + 'type' => 'string', + 'example' => '5daa9a15c7fd55523996......', + ], + 'identifier' => [ + 'title' => '工时唯一标识', + 'description' => '工时唯一标识', + 'type' => 'string', + 'example' => 'a4ac3a81e90217db32b7......', + ], + 'gmtStart' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtEnd' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'spentTime' => [ + 'description' => '预计花费工时', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'type' => [ + 'title' => '工时类型', + 'description' => '工时类型', + 'type' => 'string', + 'example' => '研发', + ], + 'description' => [ + 'title' => '工时描述信息', + 'description' => '工时描述信息', + 'type' => 'string', + 'example' => '开发代码等', + ], + 'recordUser' => [ + 'description' => '预计工时登记人', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'description' => '登记人唯一标识，aliyunPk', + 'type' => 'string', + 'example' => '132xxxx123', + ], + 'name' => [ + 'description' => '登记人姓名', + 'type' => 'string', + 'example' => '张三', + ], + ], + ], + 'gmtCreate' => [ + 'title' => '工时记录的创建时间', + 'description' => '工时记录的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + 'gmtModified' => [ + 'title' => '工时记录的修改时间', + 'description' => '工时记录的修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200000', + ], + ], + ], + ], + 'code' => [ + 'title' => '接口返回code', + 'description' => '接口返回code', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitemTimeEstimate\\": [\\n {\\n \\"workitemIdentifier\\": \\"5daa9a15c7fd55523996......\\",\\n \\"identifier\\": \\"a4ac3a81e90217db32b7......\\",\\n \\"gmtStart\\": 1653235200000,\\n \\"gmtEnd\\": 1653235200000,\\n \\"spentTime\\": 8,\\n \\"type\\": \\"研发\\",\\n \\"description\\": \\"开发代码等\\",\\n \\"recordUser\\": {\\n \\"identifier\\": \\"132xxxx123\\",\\n \\"name\\": \\"张三\\"\\n },\\n \\"gmtCreate\\": 1653235200000,\\n \\"gmtModified\\": 1653235200000\\n }\\n ],\\n \\"code\\": 200\\n}","type":"json"}]', + 'title' => '获取工作项预计工时列表', + 'description' => '获取工作项预计工时登记列表', + ], + 'UpdateWorkitemField' => [ + 'summary' => '更新工作项字段，可以支持批量更新多个字段。', + 'path' => '/organization/{organizationId}/workitems/updateWorkitemField', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '60ee8a814690c27532d412f8', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'workitemIdentifier' => [ + 'title' => '工作项id，同workitemId，工作项唯一标识', + 'description' => '工作项id，同workitemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '9144ef6b72d8exxxxx9e61a4d0', + ], + 'updateWorkitemPropertyRequest' => [ + 'title' => '更新工作项属性请求，数组形式', + 'description' => '更新工作项属性请求，数组形式', + 'type' => 'array', + 'items' => [ + 'description' => '实体属性', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '需要更新的工作项字段id，可以从获取工作项所有字段接口获取相应的数据', + 'description' => '需要更新的工作项字段id，可以从获取工作项所有字段接口获取相应的数据', + 'type' => 'string', + 'required' => true, + 'example' => 'tag', + ], + 'fieldValue' => [ + 'title' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'description' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'type' => 'string', + 'required' => true, + 'example' => '个人属性', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + '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' => '状态阶段id', + 'type' => 'string', + 'example' => '1', + ], + 'spaceIdentifier' => [ + 'title' => '所属项目id', + 'description' => '所属项目id', + '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' => '工作项的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'parentIdentifier' => [ + 'title' => '父工作项id', + 'description' => '父工作项id', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx24', + ], + 'workitemTypeIdentifier' => [ + 'title' => '工作项类型id', + 'description' => '工作项类型id', + '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' => '状态唯一标识id', + 'type' => 'string', + 'example' => '28', + ], + 'sprintIdentifier' => [ + 'title' => '迭代的id', + 'description' => '迭代的id', + 'type' => 'string', + 'example' => '75528f17703e92e5a568......', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"workitem\\": {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"document\\": \\"html格式\\",\\n \\"assignedTo\\": \\"19xx7043xxxxxxx914\\",\\n \\"status\\": \\"待处理\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"spaceIdentifier\\": \\"e8b26xxxxx6e76aa20xxxxx23\\",\\n \\"spaceName\\": \\"需求项目\\",\\n \\"spaceType\\": \\"Project\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"parentIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx24\\",\\n \\"workitemTypeIdentifier\\": \\"9uxxxxxxre573f5xxxxxx0\\",\\n \\"updateStatusAt\\": 1640850328000,\\n \\"serialNumber\\": \\"1\\",\\n \\"gmtCreate\\": 1640850318000,\\n \\"gmtModified\\": 1640850318000,\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"statusIdentifier\\": \\"28\\",\\n \\"sprintIdentifier\\": \\"75528f17703e92e5a568......\\"\\n }\\n}","type":"json"}]', + 'title' => '更新工作项字段', + 'description' => '批量更新工作项字段，只支持工作项上下文字段以及自定义字段，不能更新工作项本身属性（描述，标题，状态等，这些字段选择更新工作项属性字段）。', + ], + 'DeleteWorkitem' => [ + 'summary' => '删除工作项。', + 'path' => '/organization/{organizationId}/workitem/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'title' => '工作项id', + 'description' => '工作项id，同workitemIdentifier，workitemId，工作项唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '3ef2ef6018d254d660e65f87a6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误状态码', + 'description' => '错误状态码', + 'type' => 'string', + 'example' => 'InvalidTagGroup.IdNotFound', + ], + 'success' => [ + 'title' => 'true/false', + 'description' => 'true/false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deleteFlag' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"InvalidTagGroup.IdNotFound\\",\\n \\"success\\": true,\\n \\"deleteFlag\\": true\\n}","type":"json"}]', + 'title' => '删除工作项', + 'description' => '删除工作项，需要填写工作项属性。', + ], + 'GetWorkitemFile' => [ + 'summary' => '获取工作项的文件信息，例如工作项的描述中的图片信息。', + 'path' => '/organization/{organizationId}/workitem/{workitemIdentifier}/files/{fileIdentifier}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '60811b5eed6e867404f6xxxx', + ], + ], + [ + 'name' => 'workitemIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '工作项id，唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '11234455454355', + ], + ], + [ + 'name' => 'fileIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '文件唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'dfsdfdsgdsfdsfff', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'success', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'workitemFile' => [ + 'description' => '文件对象', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => 'sddrdfdf123df', + ], + 'name' => [ + 'description' => '文件名称', + 'type' => 'string', + 'example' => 'ddc.pdf', + ], + 'suffix' => [ + 'description' => '文件扩展名', + 'type' => 'string', + 'example' => 'pdf', + ], + 'size' => [ + 'description' => '文件内容大小，单位：bytes', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10001', + ], + 'url' => [ + 'description' => '下载的url', + 'type' => 'string', + 'example' => 'http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"success\\",\\n \\"success\\": \\"true\\",\\n \\"workitemFile\\": {\\n \\"id\\": \\"sddrdfdf123df\\",\\n \\"name\\": \\"ddc.pdf\\",\\n \\"suffix\\": \\"pdf\\",\\n \\"size\\": 10001,\\n \\"url\\": \\"http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log\\"\\n }\\n}","type":"json"}]', + 'title' => '获取工作项文件信息', + ], + 'CreateProject' => [ + 'summary' => '可以创建项目。', + 'path' => '/organization/{organizationId}/projects/createProject', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:'."\n" + .'//devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'templateIdentifier' => [ + 'description' => '项目模板id，可以从前端的项目模板列表页获取，前端接口：'."\n" + .'https://'."\n" + .'devops.aliyun.com/projex/api/workspace/template/setting/corp/listSpaceTemplatesForCreate?category=Project&_input_charset=utf-8。'."\n" + .'取值identifier: "704eaxxxx5efede61xxx5",', + 'type' => 'string', + 'required' => true, + 'example' => '704eaxxxx5efede61xxx5', + ], + 'name' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + 'scope' => [ + 'description' => '公开：public'."\n" + .'私有：private', + 'type' => 'string', + 'required' => true, + 'example' => 'public', + ], + 'customCode' => [ + 'description' => '项目编号，四到六位大写字母，企业下唯一', + 'type' => 'string', + 'required' => true, + 'example' => 'ABCD', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'project' => [ + 'title' => '项目信息', + 'description' => '项目信息', + 'type' => 'object', + 'properties' => [ + 'categoryIdentifier' => [ + 'title' => '空间大类id', + 'description' => '空间大类id，这里为Project', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人的阿里云accountID', + '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' => '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' => '修改人的阿里云accoutID', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'organizationIdentifier' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '可见范围', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '状态id', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段', + 'description' => '状态阶段', + 'type' => 'string', + 'example' => '1', + ], + 'typeIdentifier' => [ + 'title' => '空间小类id', + 'description' => '空间小类id', + 'type' => 'string', + 'example' => 'CustomProject', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"该项目用来跟进测试需求。\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"1\\",\\n \\"typeIdentifier\\": \\"CustomProject\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建项目', + ], + 'CreateSprint' => [ + 'summary' => '可以创建项目的迭代。', + 'path' => '/organization/{organizationId}/sprints/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '迭代名', + 'description' => '迭代名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例迭代', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '项目id，和projectId意义相同', + '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' => '支持企业用户名，如：张三'."\n" + .'或者用户aliyunPk', + 'type' => 'string', + 'required' => true, + 'example' => '19xx7043xxxxxxx914', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprint' => [ + 'title' => '迭代信息', + 'description' => '迭代信息', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人阿里云accountId', + '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' => '修改人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '迭代名称', + 'description' => '迭代名称', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'spaceIdentifier' => [ + 'title' => '项目id', + 'description' => '项目唯一标识', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '可见范围，公开public，私有private', + 'type' => 'string', + 'example' => 'public', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态'."\n" + ."\n" + .'未开始：Todo'."\n" + ."\n" + .'进行中：Doing'."\n" + ."\n" + .'已完成：Done', + 'type' => 'string', + 'example' => 'TODO', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"sprint\\": {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"TODO\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建迭代', + ], + 'DeleteProject' => [ + 'summary' => '可以删除项目。', + 'path' => '/organization/{organizationId}/projects/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'query', + 'schema' => [ + 'description' => '项目id，与spaceIdentifier，projectId字段相同', + 'type' => 'string', + 'required' => true, + 'example' => '7fb72727f32143574f7a...', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口返回数据', + 'description' => '接口返回数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => '接口请求成功true，'."\n" + .'接口请求失败false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'result' => [ + 'title' => 'true或者false', + 'description' => '删除成功true，'."\n" + .'删除失败false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除项目', + ], + 'UpdateProjectMember' => [ + 'summary' => '添加项目成员。', + 'path' => '/organization/{organizationId}/projects/{projectId}/updateMember', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:// devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '添加的用户信息', + 'type' => 'object', + 'properties' => [ + 'roleIdentifier' => [ + 'title' => '角色id', + 'description' => '角色id，例如管理员：project.admin，参与人：project.participant，或者其他自定义角色，id可以从https:// devops.aliyun.com/projex/api/workspace/role/list?targetType=Space&targetIdentifier=【spaceIdentifier】接口中获取到，其中spaceIdentifier为需要查询的项目id', + 'type' => 'string', + 'required' => true, + 'example' => 'project.admin', + ], + 'userIdentifier' => [ + 'title' => '用户id', + 'description' => '用户aliyunPk，也就是阿里云账号Id', + 'type' => 'string', + 'required' => true, + 'example' => '19xx7043xxxxxxx914', + ], + 'userType' => [ + 'title' => '用户类型', + 'description' => '用户类型，这里为单用户user', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'targetType' => [ + 'title' => '资源类型', + 'description' => '资源类型，这里为Space', + 'type' => 'string', + 'required' => true, + 'example' => 'Space', + ], + 'targetIdentifier' => [ + 'title' => '资源id，也就是项目id', + 'description' => '资源id，也就是项目id', + 'type' => 'string', + 'required' => true, + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同spaceIdentifier', + 'type' => 'string', + 'required' => true, + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'member' => [ + 'title' => '成员信息', + 'description' => '成员信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'id', + 'description' => 'id，暂时无用', + 'type' => 'string', + 'example' => '1124382', + ], + 'roleIdentifier' => [ + 'title' => '角色id', + 'description' => '角色id', + 'type' => 'string', + 'example' => 'project.admin', + ], + 'userIdentifier' => [ + 'title' => '用户id', + 'description' => '用户id，阿里云账号id，即aliyunPk', + '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' => '资源id，也就是项目id', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"member\\": {\\n \\"id\\": \\"1124382\\",\\n \\"roleIdentifier\\": \\"project.admin\\",\\n \\"userIdentifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"userType\\": \\"user\\",\\n \\"targetType\\": \\"Space\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"targetIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateProjectMemberResponse>\\n <success>true</success>\\n <member>\\n <gmtModified>1645685457013</gmtModified>\\n <targetIdentifier>9dc9799adc31f7725462......</targetIdentifier>\\n <roleIdentifier>project.admin</roleIdentifier>\\n <userIdentifier>1967043931......</userIdentifier>\\n <targetType>Space</targetType>\\n <id>3964010</id>\\n <userType>user</userType>\\n <gmtCreate>1645685457013</gmtCreate>\\n </member>\\n <errorCode/>\\n <errorMsg/>\\n</UpdateProjectMemberResponse>","errorExample":""}]', + 'title' => '添加更新项目成员', + ], + 'UpdateProjectField' => [ + 'summary' => '更新项目自身属性与自定义字段，以及项目状态', + 'path' => '/organization/{organizationId}/project/{identifier}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'identifier', + 'in' => 'path', + 'schema' => [ + 'title' => '更新项目的唯一标识，项目id', + 'description' => '更新项目的唯一标识，项目id', + 'type' => 'string', + 'required' => true, + 'example' => 'deafe5f33xxxxx6a259d8dafd', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'updateBasicFieldRequestList' => [ + 'title' => '更新项目基础字段列表', + 'description' => '更新基础字段数组', + 'type' => 'array', + 'items' => [ + 'title' => '更新项目基本字段对象，由属性key与属性value构成', + 'description' => '更新项目属性对象', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'title' => '基础属性key', + 'description' => '项目基础属性key', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'scope' => 'scope', + 'name' => 'name', + 'description' => 'description', + 'customCode' => 'customCode', + ], + 'example' => 'name', + ], + 'propertyValue' => [ + 'title' => '基础属性value'."\n", + 'description' => '更新后的值', + 'type' => 'string', + 'required' => false, + 'example' => '名称', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'updateForOpenApiList' => [ + 'title' => '更新项目自定义字段列表', + 'description' => '更新项目自定义字段数组', + 'type' => 'array', + 'items' => [ + 'title' => '更新项目自定义字段对象', + 'description' => '更新项目自定义字段对象', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '自定义字段id', + 'description' => '字段唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'c4fd21xxxxxxxx9oj8jk', + ], + 'value' => [ + 'title' => '自定义字段value', + 'description' => '字段值', + 'type' => 'string', + 'required' => false, + 'example' => '字段值', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'statusIdentifier' => [ + 'title' => '更新后项目状态id', + 'description' => '状态唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'fdsaadsfasxxxxdddd', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => '空间大类id，项目的值都是Project', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'title' => '创建人阿里云accountId', + 'description' => '创建人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'customCode' => [ + 'title' => '自定义编号，企业下唯一', + 'description' => '自定义编号，企业下唯一', + 'type' => 'string', + 'example' => 'OJAY', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'api测试-创建', + ], + 'gmtCreate' => [ + 'title' => '创建时间的时间戳，单位毫秒', + 'description' => '创建时间的时间戳，单位毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623916393000', + ], + 'gmtModified' => [ + 'title' => '修改时间的时间戳，单位毫秒', + 'description' => '修改时间的时间戳，单位毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684134690000', + ], + 'iconGroup' => [ + 'title' => '图标组，json格式字符串', + 'description' => '图标组，json格式字符串', + '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' => '项目id', + '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' => '修改人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'organizationIdentifier' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'parentIdentifier' => [ + 'title' => '父项目id', + 'description' => '父项目id', + 'type' => 'string', + 'example' => 'null', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '可见范围', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'title' => '状态id', + 'description' => '状态id', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段id，项目状态默认有未开始、进行中、已完成，该字段为状态具体的id。', + 'description' => '状态阶段id，项目状态默认有未开始、进行中、已完成，该字段为状态具体的id。', + 'type' => 'string', + 'example' => '8a4058a71159b68254......', + ], + 'subType' => [ + 'title' => ' '."\n" + .'空间小类', + 'description' => ' '."\n" + .'空间小类', + 'type' => 'string', + 'example' => 'null', + ], + 'typeIdentifier' => [ + 'title' => '空间小类id，该字段已废弃', + 'description' => '空间小类id，该字段已废弃', + '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' => '字段id', + 'type' => 'string', + 'example' => 'b787ff504c0b36f8b71d15a4fd', + ], + 'displayName' => [ + 'title' => '展示名称', + 'description' => '展示名称', + 'type' => 'string', + 'example' => '进行时', + ], + 'valueType' => [ + 'title' => '字段类型', + 'description' => '字段类型', + 'type' => 'string', + 'example' => 'user', + ], + 'value' => [ + 'title' => '字段值', + 'description' => '字段值', + 'type' => 'string', + 'example' => 'ace3wxxxxxxx7rff3ee', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"errormessage\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"category\\": \\"Project\\",\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"api测试-创建\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1684134690000,\\n \\"iconGroup\\": \\"{\\\\\\"small\\\\\\":\\\\\\"https://xxxxxx.png\\\\\\",\\\\\\"big\\\\\\":\\\\\\"https://img.yyyyyy.png\\\\\\"}\\",\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"iconBig\\": \\"https://xxxxxx.png\\",\\n \\"iconSmall\\": \\"https://img.yyyyyy.png\\",\\n \\"id\\": \\"66893\\",\\n \\"identifier\\": \\"1e2ea73d24652d5874d001b351\\",\\n \\"identifierPath\\": \\"e8b2xxxxxx2abdxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"parentIdentifier\\": \\"null\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"8a4058a71159b68254......\\",\\n \\"subType\\": \\"null\\",\\n \\"typeIdentifier\\": \\"CustomProject\\",\\n \\"statusName\\": \\"进行中\\",\\n \\"fieldList\\": [\\n {\\n \\"identifier\\": \\"b787ff504c0b36f8b71d15a4fd\\",\\n \\"displayName\\": \\"进行时\\",\\n \\"valueType\\": \\"user\\",\\n \\"value\\": \\"ace3wxxxxxxx7rff3ee\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '更新项目属性与字段', + 'description' => '更新项目自身属性与自定义字段，以及项目状态', + ], + 'GetProjectInfo' => [ + 'summary' => '根据projectId获取项目基本信息。', + 'path' => '/organization/{organizationId}/project/{projectId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同spaceIdentifier', + 'type' => 'string', + 'required' => true, + 'example' => 'e8b2xxxxxxx09b07d23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '项目信息', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息'."\n" + ."\n", + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'description' => 'true或者false'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'project' => [ + 'title' => '项目信息', + 'description' => '项目信息', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => '空间大类', + 'type' => 'string', + 'example' => 'null', + ], + 'categoryIdentifier' => [ + 'description' => '空间大类id，项目的值都是Project', + 'type' => 'string', + 'example' => 'Project', + ], + 'creator' => [ + 'description' => '创建人阿里云accountId', + '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' => '图标组，json格式字符串', + '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' => '项目id', + 'type' => 'string', + 'example' => 'null', + ], + 'identifier' => [ + 'description' => '项目唯一标识符', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'identifierPath' => [ + 'description' => '空间路径', + 'type' => 'string', + 'example' => 'e8b2xxxxxx2abdxxxxxxxx23', + ], + 'logicalStatus' => [ + 'description' => '项目状态', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'modifier' => [ + 'description' => '修改人阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'demo示例项目', + ], + 'organizationIdentifier' => [ + 'description' => '企业id', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'parentIdentifier' => [ + 'description' => '父项目id', + 'type' => 'string', + 'example' => 'null', + ], + 'scope' => [ + 'description' => '可见范围', + 'type' => 'string', + 'example' => 'public', + ], + 'statusIdentifier' => [ + 'description' => '状态id', + 'type' => 'string', + 'example' => '8a40xxxxxxxxxxxxx64', + ], + 'statusStageIdentifier' => [ + 'description' => '状态阶段id，项目状态默认有未开始、进行中、已完成，该字段为状态具体的id。', + 'type' => 'string', + 'example' => '8a4058a71159b68254......', + ], + 'subType' => [ + 'description' => '空间小类', + 'type' => 'string', + 'example' => 'null', + ], + 'typeIdentifier' => [ + 'description' => '空间小类id，该字段已废弃', + 'type' => 'string', + 'example' => 'CustomProject', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"project\\": {\\n \\"category\\": \\"null\\",\\n \\"categoryIdentifier\\": \\"Project\\",\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"iconGroup\\": \\"{\\\\\\"small\\\\\\":\\\\\\"https://xxxxxx.png\\\\\\",\\\\\\"big\\\\\\":\\\\\\"https://img.yyyyyy.png\\\\\\"}\\",\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"iconBig\\": \\"https://xxxxxx.png\\",\\n \\"iconSmall\\": \\"https://img.yyyyyy.png\\",\\n \\"id\\": \\"null\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"identifierPath\\": \\"e8b2xxxxxx2abdxxxxxxxx23\\",\\n \\"logicalStatus\\": \\"NORMAL\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"organizationIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"parentIdentifier\\": \\"null\\",\\n \\"scope\\": \\"public\\",\\n \\"statusIdentifier\\": \\"8a40xxxxxxxxxxxxx64\\",\\n \\"statusStageIdentifier\\": \\"8a4058a71159b68254......\\",\\n \\"subType\\": \\"null\\",\\n \\"typeIdentifier\\": \\"CustomProject\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取项目详情', + ], + 'ListProjectMembers' => [ + 'summary' => '获取项目成员。', + 'path' => '/organization/{organizationId}/projects/{projectId}/listMembers', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目id，同spaceIdentifier', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxx2abd6e76aa209b07d23', + ], + ], + [ + 'name' => 'targetType', + 'in' => 'query', + 'schema' => [ + 'description' => '请求资源的类型，这里填Space即可。', + 'type' => 'string', + 'required' => true, + 'example' => 'Space', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'members' => [ + 'title' => 'member信息', + 'description' => 'member信息', + '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' => '钉钉id', + 'type' => 'string', + 'example' => 'null', + ], + 'displayName' => [ + 'title' => '展示名', + 'description' => '展示名', + 'type' => 'string', + 'example' => '名称', + ], + 'displayNickName' => [ + 'title' => '展示昵称', + 'description' => '展示昵称', + 'type' => 'string', + 'example' => 'mingcheng', + ], + 'displayRealName' => [ + 'title' => '展示真名', + 'description' => '展示真名', + 'type' => 'string', + 'example' => '名称', + ], + 'division' => [ + 'title' => '部门信息', + 'description' => '部门信息', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '部门唯一标识', + 'description' => '部门唯一标识', + 'type' => 'string', + 'example' => '1345xxxxxxx947xxxx', + ], + ], + ], + 'email' => [ + 'title' => '邮箱', + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'gender' => [ + 'title' => '性别', + 'description' => '性别', + 'type' => 'string', + 'example' => 'null', + ], + 'identifier' => [ + 'title' => '用户唯一 标识符', + 'description' => '用户唯一 标识符', + 'type' => 'string', + 'example' => '19xxxx31947xxxx', + ], + 'mobile' => [ + 'title' => '手机号', + 'description' => '手机号', + 'type' => 'string', + 'example' => '135xxxxxxxxx', + ], + 'nameEn' => [ + 'title' => '英文名', + 'description' => '英文名', + 'type' => 'string', + 'example' => 'name', + ], + 'nickName' => [ + 'title' => '昵称', + 'description' => '昵称', + 'type' => 'string', + 'example' => '昵称', + ], + 'nickNamePinyin' => [ + 'title' => '昵称拼音', + 'description' => '昵称拼音', + 'type' => 'string', + 'example' => 'nicheng', + ], + 'organizationUserInfo' => [ + 'title' => '企业信息', + 'description' => '企业信息', + 'type' => 'object', + 'properties' => [ + 'organizationIdentifier' => [ + 'title' => '企业唯一标识符', + 'description' => '企业唯一标识符', + 'type' => 'string', + 'example' => '5e7xxxxb3cd3711dd6xxx2c', + ], + ], + ], + 'realName' => [ + 'title' => '真名', + 'description' => '真名', + 'type' => 'string', + 'example' => 'xxx', + ], + 'realNamePinyin' => [ + 'title' => '真名拼音', + 'description' => '真名拼音', + 'type' => 'string', + 'example' => 'xxx', + ], + 'stamp' => [ + 'title' => '用户类型', + 'description' => '用户类型，返回User、UserGroup，表示是用户或是用户组', + 'type' => 'string', + 'example' => 'User', + ], + 'tbRoleId' => [ + 'title' => '角色id', + 'description' => '角色id', + 'type' => 'string', + 'example' => 'null', + ], + 'roleName' => [ + 'title' => '角色名称', + 'description' => '角色名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + [ + [ + 'errorCode' => 'InvaildSpace.NotInCurrentOrganization', + 'errorMessage' => 'space not belong to this organization, please switch organization.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"members\\": [\\n {\\n \\"account\\": \\"null\\",\\n \\"avatar\\": \\"https://xxxxxx.png\\",\\n \\"dingTalkId\\": \\"null\\",\\n \\"displayName\\": \\"名称\\",\\n \\"displayNickName\\": \\"mingcheng\\",\\n \\"displayRealName\\": \\"名称\\",\\n \\"division\\": {\\n \\"identifier\\": \\"1345xxxxxxx947xxxx\\"\\n },\\n \\"email\\": \\"[email protected]\\",\\n \\"gender\\": \\"null\\",\\n \\"identifier\\": \\"19xxxx31947xxxx\\",\\n \\"mobile\\": \\"135xxxxxxxxx\\",\\n \\"nameEn\\": \\"name\\",\\n \\"nickName\\": \\"昵称\\",\\n \\"nickNamePinyin\\": \\"nicheng\\",\\n \\"organizationUserInfo\\": {\\n \\"organizationIdentifier\\": \\"5e7xxxxb3cd3711dd6xxx2c\\"\\n },\\n \\"realName\\": \\"xxx\\",\\n \\"realNamePinyin\\": \\"xxx\\",\\n \\"stamp\\": \\"User\\",\\n \\"tbRoleId\\": \\"null\\",\\n \\"roleName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectMembersResponse>\\n <requestId>A62F5DDC-B32C-571F-84F1-CBE93D......</requestId>\\n <success>true</success>\\n <members>\\n <division/>\\n <identifier>1967043931......</identifier>\\n <realName>云效助手</realName>\\n <organizationUserInfo/>\\n <displayName>云效助手</displayName>\\n <nickName>云效助手</nickName>\\n <avatar>https://tcs-devops.aliyuncs.com/thumbnail/112fcefd06c528b47117112402e55f....../w/100/h/100</avatar>\\n </members>\\n <errorCode/>\\n <errorMsg/>\\n</ListProjectMembersResponse>","errorExample":""}]', + 'title' => '获取项目成员', + ], + 'GetSprintInfo' => [ + 'summary' => '获取迭代详情。', + 'path' => '/organization/{organizationId}/sprints/{sprintId}/getSprintinfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'sprintId', + 'in' => 'path', + 'schema' => [ + 'title' => '迭代id', + 'description' => '迭代id', + 'type' => 'string', + 'required' => true, + 'example' => 'd061ca90d47a0b7cd4d2...', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '迭代请求结果', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Openapi.RequestError', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'success' => [ + 'description' => 'true或者false'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprint' => [ + 'title' => '迭代信息', + 'description' => '迭代信息', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人id', + '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', + ], + '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' => '项目id', + 'type' => 'string', + 'example' => '5e70xxxxxxcd000xxxxe96', + ], + 'scope' => [ + 'title' => '可见范围', + 'description' => '可见范围', + 'type' => 'string', + 'example' => 'public', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态'."\n" + .'未开始：Todo'."\n" + .'进行中：Doing'."\n" + .'已完成：Done', + 'type' => 'string', + 'example' => 'Todo', + ], + 'owners' => [ + 'description' => '迭代负责人列表', + 'type' => 'array', + 'items' => [ + 'description' => '迭代负责人的阿里云id', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"errorMessage\\": \\"error\\",\\n \\"success\\": true,\\n \\"sprint\\": {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"迭代详细描述\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"Todo\\",\\n \\"owners\\": [\\n \\"19xx7043xxxxxxx914\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSprintInfoResponse>\\n <requestId>C79CF3C1-E25F-13BB-99C2-687E14...</requestId>\\n <success>true</success>\\n <sprint>\\n <identifier>4c0974066a1c9f88a91d...</identifier>\\n <gmtModified>1642409799000</gmtModified>\\n <name>000013</name>\\n <spaceIdentifier>7fb72727f32143574f7a...</spaceIdentifier>\\n <gmtCreate>1642409799000</gmtCreate>\\n <startDate>1638403200000</startDate>\\n <status>TODO</status>\\n </sprint>\\n <errorMessage/>\\n <errorCode/>\\n</GetSprintInfoResponse>","errorExample":""}]', + 'title' => '获取迭代详情', + ], + 'ListProjects' => [ + 'summary' => '获取项目列表，支持条件搜索。', + 'path' => '/organization/{organizationId}/listProjects', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'extraConditions', + 'in' => 'query', + 'schema' => [ + 'description' => '1. 全部项目的搜索条件为：'."\n" + .'{"conditionGroups":[[{"className":"user","fieldIdentifier":"users","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d...]}],[{"className":"string","fieldIdentifier":"scope","format":"list","operator":"CONTAINS","value":["public"]}]]}'."\n" + .'2. 我管理的项项目条件为：'."\n" + .'{"conditionGroups":[[{"className":"user","fieldIdentifier":"project.admin","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d..."]}]]}'."\n" + .'3. 具体其他的搜索条件，可以参考页面上的项目列表中请求/project/search/list的搜索参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '附加过滤条件', + ], + ], + [ + 'name' => 'conditions', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤条件', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "conditionGroups": ['."\n" + .' []'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '项目类型', + 'description' => '项目类型，这里填Project即可', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '第一页值不需要填写，后面每一页的值需要从前一次调用结果中获取到此字段，然后获取后面的分页数据', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '每页最大返回数量，0-200，默认值20', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'schema' => [ + 'title' => '公开类型', + 'description' => '公开类型，all/collect，分别代表所有的项目或者我收藏的', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '分页Token，没有下一页则为空', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'projects' => [ + 'title' => '项目信息', + 'description' => '项目信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人', + 'description' => '创建人aliyunPK', + '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' => '类型id', + 'type' => 'string', + 'example' => 'null', + ], + 'statusStageIdentifier' => [ + 'title' => '状态阶段', + 'description' => '状态阶段', + 'type' => 'string', + 'example' => 'null', + ], + 'logicalStatus' => [ + 'title' => '逻辑状态', + 'description' => '逻辑状态', + 'type' => 'string', + 'example' => 'null', + ], + 'categoryIdentifier' => [ + 'title' => '类型', + 'description' => '资源大类型', + 'type' => 'string', + 'example' => 'Project', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"projects\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"customCode\\": \\"OJAY\\",\\n \\"deleteTime\\": 0,\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1640778694000,\\n \\"icon\\": \\"https://xxxxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"name\\": \\"xxxx\\",\\n \\"scope\\": \\"public\\",\\n \\"typeIdentifier\\": \\"null\\",\\n \\"statusStageIdentifier\\": \\"null\\",\\n \\"logicalStatus\\": \\"null\\",\\n \\"categoryIdentifier\\": \\"Project\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectsResponse>\\n <projects>\\n <identifier>9dc9799adc31f7725462......</identifier>\\n <creator>1811837656......</creator>\\n <scope>public</scope>\\n <icon>https://img.alicdn.com/imgextra/i1/O1CN01TcSBKH1k0vIWjGzXg_!!6000000......-2-tps-96-96.png</icon>\\n <name>测试项目</name>\\n <description/>\\n <gmtCreate>1645671160000</gmtCreate>\\n <categoryIdentifier>Project</categoryIdentifier>\\n <customCode>YKYK</customCode>\\n </projects>\\n <projects>\\n <identifier>be0e5269fce1cfe271a4......</identifier>\\n <creator>1967043931......</creator>\\n <scope>public</scope>\\n <name>12345690</name>\\n <gmtCreate>1645669608000</gmtCreate>\\n <categoryIdentifier>Project</categoryIdentifier>\\n <customCode>ASDFO</customCode>\\n </projects>\\n <nextToken>94239cc6cad0b0a23fc4......</nextToken>\\n <maxResults>20</maxResults>\\n <requestId>6592ADB6-A4B5-5BEB-82A1-C649BD......</requestId>\\n <success>true</success>\\n <errorCode/>\\n <totalCount>116</totalCount>\\n <errorMsg/>\\n</ListProjectsResponse>","errorExample":""}]', + 'title' => '获取项目列表', + ], + 'ListProjectTemplates' => [ + 'summary' => '获取项目模板列表。', + 'path' => '/organization/{organizationId}/projects/listTemplates', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型，这里的场景只用填Project', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'templates' => [ + 'title' => '项目模板信息', + 'description' => '项目模板信息', + 'type' => 'array', + 'items' => [ + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人的阿里云accountId', + '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' => '模板类型 '."\n" + .'0-system'."\n" + .'4-custom'."\n" + .'16-instance', + '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' => '修改人的阿里云accountId', + 'type' => 'string', + 'example' => '19xx7043xxxxxxx914', + ], + 'name' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => '专用模板', + ], + 'nameEn' => [ + 'title' => '模板英文名称', + 'description' => '模板英文名称', + 'type' => 'string', + 'example' => 'Test Template', + ], + 'resourceCategory' => [ + 'title' => '所属资源类型', + 'description' => '所属资源类型', + 'type' => 'string', + 'example' => 'Project', + ], + 'copyFrom' => [ + 'description' => '废弃字段', + 'type' => 'string', + 'example' => 'null', + ], + 'resourceType' => [ + 'description' => '废弃字段', + 'type' => 'string', + 'example' => 'null', + ], + 'spaceIdentifier' => [ + 'description' => '废弃字段', + 'type' => 'string', + 'example' => 'null', + ], + 'spaceType' => [ + 'description' => '废弃字段', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"templates\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"迭代的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": 4,\\n \\"icon\\": \\"https://img.xxxx.png\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"专用模板\\",\\n \\"nameEn\\": \\"Test Template\\",\\n \\"resourceCategory\\": \\"Project\\",\\n \\"copyFrom\\": \\"null\\",\\n \\"resourceType\\": \\"null\\",\\n \\"spaceIdentifier\\": \\"null\\",\\n \\"spaceType\\": \\"null\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取项目模板列表', + ], + 'ListSprints' => [ + 'summary' => '获取迭代列表。', + 'path' => '/organization/{organizationId}/sprints/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => '项目唯一标识，同projectId', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + [ + 'name' => 'spaceType', + 'in' => 'query', + 'schema' => [ + 'title' => '类型', + 'description' => '类型，这里就写Project', + 'type' => 'string', + 'required' => true, + 'example' => 'Project', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页中的起始序列', + 'description' => '第一页值不需要填写，后面每一页的值需要从前一次调用结果中获取到此字段，然后获取后面的分页数据', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大返回数量，0-200，默认值20', + 'description' => '每页最大返回数量，0-200，默认值20'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '分页Token，没有下一页则为空', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sprints' => [ + 'title' => '迭代信息', + 'description' => '迭代信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人aliyunPk', + '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' => '修改人aliyunPk', + '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' => '状态，TODO，DOING，DONE，分别代表迭代未开始，进行中和已完成', + 'type' => 'string', + 'example' => 'TODO', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"sprints\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"xxx\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"endDate\\": 1623916393000,\\n \\"startDate\\": 1638403200000,\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"demo示例项目\\",\\n \\"spaceIdentifier\\": \\"5e70xxxxxxcd000xxxxe96\\",\\n \\"scope\\": \\"public\\",\\n \\"status\\": \\"TODO\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取迭代列表', + ], + 'CreateTestCase' => [ + 'summary' => '用例库中创建测试用例', + 'path' => '/organization/{organizationId}/testhub/testcase', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'subject' => [ + 'title' => '测试用例标题', + 'description' => '测试用例标题', + 'type' => 'string', + 'required' => true, + 'example' => '测试工作项', + ], + 'assignedTo' => [ + 'title' => '负责人id', + 'description' => '负责人id', + 'type' => 'string', + 'required' => true, + 'example' => '19xxxx31947xxxx', + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '用例库id', + 'type' => 'string', + 'required' => true, + 'example' => 'asd345xxxxx9q9845xxxxx34', + ], + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '目录id', + 'type' => 'string', + 'required' => true, + 'example' => 'fdd395xxxxx9q9845xxxxx23'."\n", + ], + 'priority' => [ + 'title' => '用例优先级', + 'description' => '用例优先级', + 'type' => 'string', + 'required' => false, + 'example' => 'ik3dexxxxxfdfds1xxxxx23', + ], + 'tags' => [ + 'title' => '标签id数组', + 'description' => '标签id数组', + 'type' => 'array', + 'items' => [ + 'description' => '标签唯一标识，标签id', + 'type' => 'string', + 'required' => false, + 'example' => 'opwxsxxxxxf5434xxxxx12', + ], + 'required' => false, + ], + 'fieldValueList' => [ + 'title' => '自定义字段列表', + 'description' => '自定义字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '需要先通过获取工作项字段的接口：ListTestCaseAllFields 查看哪些字段是必填，isRequired为true的则为必填。', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段id', + 'description' => '字段id', + 'type' => 'string', + 'required' => false, + 'example' => '6aexxxxxa1d98c09c60xxxx16', + ], + 'value' => [ + 'title' => '字段值', + 'description' => '字段值', + 'type' => 'string', + 'required' => false, + 'example' => '77c7fb03c4186c8691d6...', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'testcaseStepContentInfo' => [ + 'title' => '', + 'description' => '测试用例步骤内容信息', + 'type' => 'object', + 'properties' => [ + 'precondition' => [ + 'title' => '前置条件', + 'description' => '前置条件', + 'type' => 'string', + 'required' => false, + 'example' => '前置条件内容', + ], + 'stepType' => [ + 'title' => '测试步骤格式，只有表格和文本两种形式', + 'description' => '测试步骤格式，只有表格和文本两种形式', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'TABLE' => 'TABLE', + 'TEXT' => 'TEXT', + ], + 'example' => 'TEXT', + 'enum' => [ + 'TEXT', + 'TABLE', + ], + ], + 'stepResultList' => [ + 'title' => '测试用例步骤与内容，如果该内容为文本形式，则stepResultList只会取第一组值，并且可以给步骤内容和预期结果设置格式；如果该内容为表格形式，则会取到每一组步骤和内容值，但是无法设置步骤内容和预期结果的格式。', + 'description' => '测试用例步骤与内容，如果该内容为文本形式，则stepResultList只会取第一组值，并且可以给步骤内容和预期结果设置格式；如果该内容为表格形式，则会取到每一组步骤和内容值，但是无法设置步骤内容和预期结果的格式。', + 'type' => 'array', + 'items' => [ + 'description' => 'step为测试步骤，expected为预期结果', + 'type' => 'object', + 'properties' => [ + 'step' => [ + 'title' => '测试步骤', + 'description' => '测试步骤', + 'type' => 'string', + 'required' => false, + 'example' => '测试第一步骤', + ], + 'expected' => [ + 'title' => '测试内容', + 'description' => '测试内容', + 'type' => 'string', + 'required' => false, + 'example' => '测试第一步预期结果', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '18E50717-93A4-53BC-A30D-963F742A1CE6', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testcase' => [ + 'description' => '测试用例实体', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例id', + 'description' => '测试用例id', + 'type' => 'string', + 'example' => '5a73f81c834d013361d92bdcce', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => '标题', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '负责人信息', + 'type' => 'object', + 'properties' => [ + 'assignIdentifier' => [ + 'title' => '用户Id', + 'description' => '用户Id', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '用户名称', + 'description' => '用户名称', + 'type' => 'string', + 'example' => '人员名称', + ], + 'tbRoleId' => [ + 'title' => '人员角色id', + 'description' => '人员角色id', + 'type' => 'string', + 'example' => '3c2253c22xxxxxxxx53a', + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '用例库id', + 'type' => 'string', + 'example' => 'a18571eba8fe9267cd8375fc06', + ], + 'spaceType' => [ + 'title' => '空间类型，为TestRepo', + 'description' => '空间类型，为TestRepo', + 'type' => 'string', + 'example' => 'TestRepo'."\n" + ."\n", + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型id，一般为TestCase', + 'description' => '工作项类型id，一般为TestCase', + 'type' => 'string', + 'example' => 'TestCase'."\n" + ."\n", + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => [ + 'title' => '创建者id', + 'description' => '创建者id', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '创建者名称', + 'description' => '创建者名称', + 'type' => 'string', + 'example' => '人员名称', + ], + ], + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => [ + 'title' => '修改者id', + 'description' => '修改者id', + 'type' => 'string', + 'example' => '134xxx343xxxxx', + ], + 'name' => [ + 'title' => '修改者名称', + 'description' => '修改者名称', + 'type' => 'string', + 'example' => '人员名称', + ], + ], + ], + 'directory' => [ + 'title' => '目录信息', + 'description' => '目录信息', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '目录id', + 'type' => 'string', + 'example' => '0bc1150dcxxxxxxxx04c', + ], + 'name' => [ + 'title' => '目录名称', + 'description' => '目录名称', + 'type' => 'string', + 'example' => '全部目录', + ], + 'pathName' => [ + 'title' => '用例完整目录名', + 'description' => '用例完整目录名', + 'type' => 'array', + 'items' => [ + 'description' => '目录层次', + 'type' => 'string', + 'example' => '[一级目录，二级目录]', + ], + ], + 'childIdentifier' => [ + 'title' => '子目录id', + 'description' => '子目录id', + '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' => '前置条件id', + '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' => '测试步骤id', + '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' => '预期结果id', + 'type' => 'string', + 'example' => '59253164xxxxxxf2e98dbc7e27', + ], + 'expectContent' => [ + 'title' => '预期结果内容', + 'description' => '预期结果内容', + 'type' => 'string', + 'example' => '预期结果', + ], + 'expectContentType' => [ + 'title' => '预期结果格式', + 'description' => '预期结果格式', + 'type' => 'string', + 'example' => 'RICHTEXT', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"18E50717-93A4-53BC-A30D-963F742A1CE6\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"testcase\\": {\\n \\"identifier\\": \\"5a73f81c834d013361d92bdcce\\",\\n \\"subject\\": \\"标题\\",\\n \\"assignedTo\\": {\\n \\"assignIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\",\\n \\"tbRoleId\\": \\"3c2253c22xxxxxxxx53a\\"\\n },\\n \\"spaceIdentifier\\": \\"a18571eba8fe9267cd8375fc06\\",\\n \\"spaceType\\": \\"TestRepo\\\\n\\\\n\\",\\n \\"categoryIdentifier\\": \\"TestCase\\\\n\\\\n\\",\\n \\"creator\\": {\\n \\"createIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"modifier\\": {\\n \\"modifyIdentifier\\": \\"134xxx343xxxxx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"directory\\": {\\n \\"directoryIdentifier\\": \\"0bc1150dcxxxxxxxx04c\\",\\n \\"name\\": \\"全部目录\\",\\n \\"pathName\\": [\\n \\"[一级目录，二级目录]\\"\\n ],\\n \\"childIdentifier\\": \\"0bc1150dcxxxxxxxx04c\\"\\n },\\n \\"detailInfo\\": {\\n \\"stepType\\": \\"TEXT/TABLE\\",\\n \\"precondition\\": {\\n \\"preIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"preContent\\": \\"前置条件内容\\",\\n \\"preContentType\\": \\"RICHTEXT\\"\\n },\\n \\"stepContent\\": {\\n \\"stepIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"stepContent\\": \\"测试步骤内容\\",\\n \\"stepContentType\\": \\"RICHTEXT\\"\\n },\\n \\"expectedResult\\": {\\n \\"expectIdentifier\\": \\"59253164xxxxxxf2e98dbc7e27\\",\\n \\"expectContent\\": \\"预期结果\\",\\n \\"expectContentType\\": \\"RICHTEXT\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建测试用例', + 'description' => '用例库中创建测试用例，填写的人员信息必须要使用aliyunPk', + ], + 'UpdateTestCase' => [ + 'summary' => '更新用例库测试用例属性，包括标题，目录，自定义字段信息等，但是不能用来更新测试用例的测试内容相关信息', + 'path' => '/organization/{organizationId}/testhub/testcase/{testcaseIdentifier}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testcaseIdentifier', + 'in' => 'path', + 'schema' => [ + 'title' => '测试用例id，测试用例唯一标识', + 'description' => '测试用例id，测试用例唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '4e22xxxxxxxxc64c16037fe76', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'updateWorkitemPropertyRequest' => [ + 'title' => '更新测试用例属性请求，数组形式', + 'description' => '更新测试用例属性请求，数组形式', + 'type' => 'array', + 'items' => [ + 'description' => '实体属性', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '需要更新的测试用例字段id', + 'description' => '需要更新的测试用例字段id', + 'type' => 'string', + 'required' => true, + 'example' => 'tc.type', + ], + 'fieldValue' => [ + 'title' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'description' => '需要更新字段的属性值 (注：1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段，填写相应的待选值的id。 3.如果多个值，需要用" , "进行分割，拼接成一个字符串。', + 'type' => 'string', + 'required' => true, + 'example' => '0a032xx28107xxxx53e87a9', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'errorMsg' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Testcase' => [ + 'description' => '测试用例对象', + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例id', + 'description' => '测试用例id', + 'type' => 'string', + 'example' => 'c7f7033b021ead52cc42721382', + ], + 'subject' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => '测试用例标题', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '负责人信息', + 'type' => 'object', + 'properties' => [ + 'assignIdentifier' => [ + 'title' => '用户Id', + 'description' => '用户Id', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '用户名称', + 'description' => '用户名称', + 'type' => 'string', + 'example' => '用户姓名', + ], + 'tbRoleId' => [ + 'title' => '人员角色id', + 'description' => '人员角色id', + 'type' => 'string', + 'example' => 'xxxxxxxewdds12xxx'."\n", + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '用例库id', + 'description' => '用例库id', + 'type' => 'string', + 'example' => '1e7d7a412b91a2144ec4aa8411', + ], + 'spaceType' => [ + 'title' => '空间类型，为TestRepo', + 'description' => '空间类型，为TestRepo', + 'type' => 'string', + 'example' => 'TestRepo', + ], + 'categoryIdentifier' => [ + 'title' => '工作项类型id，一般为TestCase', + 'description' => '工作项类型id，一般为TestCase', + 'type' => 'string', + 'example' => 'TestCase'."\n" + ."\n", + ], + 'creator' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'object', + 'properties' => [ + 'createIdentifier' => [ + 'title' => '创建者id', + 'description' => '创建者id', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '创建者名称', + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + ], + ], + 'modifier' => [ + 'title' => '修改人', + 'description' => '修改人', + 'type' => 'object', + 'properties' => [ + 'modifyIdentifier' => [ + 'title' => '修改者id', + 'description' => '修改者id', + 'type' => 'string', + 'example' => '1316xxxxxx8624xxx', + ], + 'name' => [ + 'title' => '修改者名称', + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'xxxxxxx', + ], + ], + ], + 'directory' => [ + 'title' => '目录信息', + 'description' => '目录信息', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录id', + 'description' => '目录id', + 'type' => 'string', + 'example' => 'e27b8eace6501ce51cf5d56784', + ], + 'name' => [ + 'title' => '目录名称', + 'description' => '目录名称', + 'type' => 'string', + 'example' => '全部用例目录', + ], + 'pathName' => [ + 'title' => '用例完整目录名', + 'description' => '用例完整目录名', + 'type' => 'array', + 'items' => [ + 'description' => '目录路径名', + 'type' => 'string', + 'example' => '[目录一，目录二]', + ], + ], + 'childIdentifier' => [ + 'title' => '子目录id', + 'description' => '子目录id', + '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' => '前置条件id', + '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' => '测试步骤id', + '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' => '预期结果id', + 'type' => 'string', + 'example' => '685340d13127b01185335bd360', + ], + 'expectContent' => [ + 'title' => '预期结果内容', + 'description' => '预期结果内容', + 'type' => 'string', + 'example' => '预期结果内容', + ], + 'expectContentType' => [ + 'title' => '预期结果格式', + 'description' => '预期结果格式', + 'type' => 'string', + 'example' => 'MARKDOWN', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"Testcase\\": {\\n \\"identifier\\": \\"c7f7033b021ead52cc42721382\\",\\n \\"subject\\": \\"测试用例标题\\",\\n \\"assignedTo\\": {\\n \\"assignIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"用户姓名\\",\\n \\"tbRoleId\\": \\"xxxxxxxewdds12xxx\\\\n\\"\\n },\\n \\"spaceIdentifier\\": \\"1e7d7a412b91a2144ec4aa8411\\",\\n \\"spaceType\\": \\"TestRepo\\",\\n \\"categoryIdentifier\\": \\"TestCase\\\\n\\\\n\\",\\n \\"creator\\": {\\n \\"createIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"xxxxxxx\\"\\n },\\n \\"modifier\\": {\\n \\"modifyIdentifier\\": \\"1316xxxxxx8624xxx\\",\\n \\"name\\": \\"xxxxxxx\\"\\n },\\n \\"directory\\": {\\n \\"directoryIdentifier\\": \\"e27b8eace6501ce51cf5d56784\\",\\n \\"name\\": \\"全部用例目录\\",\\n \\"pathName\\": [\\n \\"[目录一，目录二]\\"\\n ],\\n \\"childIdentifier\\": \\"2973f597c14c6f533fffdcd05c\\"\\n },\\n \\"detailInfo\\": {\\n \\"stepType\\": \\"TEXT/TABLE\\",\\n \\"precondition\\": {\\n \\"preIdentifier\\": \\"3354596c7b3004480b635acf95\\",\\n \\"preContent\\": \\"前置条件内容\\",\\n \\"preContentType\\": \\"MARKDOWN\\"\\n },\\n \\"stepContent\\": {\\n \\"stepIdentifier\\": \\"ad504e6cdcd2165b28eb1e1b9f\\",\\n \\"stepContent\\": \\"测试步骤内容\\",\\n \\"stepContentType\\": \\"RICHTEXT\\"\\n },\\n \\"expectedResult\\": {\\n \\"expectIdentifier\\": \\"685340d13127b01185335bd360\\",\\n \\"expectContent\\": \\"预期结果内容\\",\\n \\"expectContentType\\": \\"MARKDOWN\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '更新用例库测试用例属性', + 'description' => '使用获取测试用例字段列表可以获取到相应的测试用例所拥有的字段列表，然后根据该列表对测试用例信息进行更新', + ], + 'ListTestCaseFields' => [ + 'summary' => '获取测试用例全部字段', + 'path' => '/organization/{organizationId}/testhub/testcase/fields', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https:'."\n" + .'//devops.aliyun.com/organization/【OrganizationId】', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'spaceIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '测试用例库id，测试用例库唯一标识', + 'description' => '测试用例库id，测试用例库唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'fields' => [ + 'title' => '字段信息', + 'description' => '字段信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'title' => '创建人id', + 'description' => '创建人id', + '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' => '展示级别，数字范围1~9，数字越大，颜色越浅。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"fields\\": [\\n {\\n \\"creator\\": \\"19xx7043xxxxxxx914\\",\\n \\"description\\": \\"字段的具体信息\\",\\n \\"gmtCreate\\": 1623916393000,\\n \\"gmtModified\\": 1623916393000,\\n \\"type\\": \\"NativeField\\",\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"modifier\\": \\"19xx7043xxxxxxx914\\",\\n \\"name\\": \\"负责人\\",\\n \\"format\\": \\"list\\",\\n \\"className\\": \\"例：date\\",\\n \\"resourceType\\": \\"例：Workitem\\",\\n \\"defaultValue\\": \\"123\\",\\n \\"isRequired\\": false,\\n \\"isSystemRequired\\": false,\\n \\"linkWithService\\": \\"null\\",\\n \\"isShowWhenCreate\\": false,\\n \\"options\\": [\\n {\\n \\"identifier\\": \\"重复的缺陷\\",\\n \\"fieldIdentifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"value\\": \\"重复的缺陷\\",\\n \\"valueEn\\": \\"null\\",\\n \\"displayValue\\": \\"重复的缺陷\\",\\n \\"position\\": 0,\\n \\"level\\": 1\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取测试用例字段列表', + ], + 'GetTestcaseList' => [ + 'summary' => '获取测试用例库中的测试用例列表，支持条件过滤', + 'path' => '/organization/{organizationId}/testhub/testcases', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => [ + 'title' => '用例库id，用例库唯一标识', + 'description' => '用例库id，用例库唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '6d5984c7d92b23fa53d4743c37', + ], + 'directoryIdentifier' => [ + 'title' => '目录id，目录唯一标识，如果不填写，则默认该用例库下所有用例', + 'description' => '目录id，目录唯一标识，如果不填写，则默认该用例库下所有用例', + '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' => '分页大小，默认为20', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '分页Token，没有下一页则为空', + 'description' => '分页Token，没有下一页则为空', + 'type' => 'string', + 'example' => '""', + ], + 'maxResults' => [ + 'title' => '每页数量', + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testcase' => [ + 'title' => '工作项信息', + 'description' => '工作项信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identifier' => [ + 'title' => '测试用例Id，测试用例唯一标识', + 'description' => '测试用例Id，测试用例唯一标识', + 'type' => 'string', + 'example' => 'e8bxxxxxxxxxxxxxxxx23', + ], + 'subject' => [ + 'title' => '测试用例标题', + 'description' => '测试用例标题', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '负责人信息', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => [ + 'title' => '负责人id，负责人唯一标识', + 'description' => '负责人id，负责人唯一标识', + 'type' => 'string', + 'example' => '12xxxxx456', + ], + 'name' => [ + 'title' => '负责人姓名', + 'description' => '负责人姓名', + 'type' => 'string', + 'example' => '人员名称', + ], + ], + ], + 'space' => [ + 'title' => '用例库信息', + 'description' => '用例库信息', + 'type' => 'object', + 'properties' => [ + 'spaceIdentifier' => [ + 'title' => '用例库id，用例库唯一标识', + 'description' => '用例库id，用例库唯一标识', + 'type' => 'string', + 'example' => '22c32972b853cd703dbf0efe4c', + ], + 'type' => [ + 'title' => '空间类型', + 'description' => '空间类型', + 'type' => 'string', + 'example' => 'TestRepo', + ], + ], + ], + 'categoryIdentifier' => [ + 'title' => '测试用例的类型id', + 'description' => '测试用例的类型id', + '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' => '字段id，自定义字段唯一标识', + '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' => '标签id，标签唯一标识', + 'type' => 'string', + 'example' => '85702b33f14bxxxxxx58173ba', + ], + 'name' => [ + 'title' => '标签名称', + 'description' => '标签名称', + 'type' => 'string', + 'example' => '标签名称', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"maxResults\\": 20,\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"testcase\\": [\\n {\\n \\"identifier\\": \\"e8bxxxxxxxxxxxxxxxx23\\",\\n \\"subject\\": \\"测试工作项\\",\\n \\"assignedTo\\": {\\n \\"assignedToIdenttifier\\": \\"12xxxxx456\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"space\\": {\\n \\"spaceIdentifier\\": \\"22c32972b853cd703dbf0efe4c\\",\\n \\"type\\": \\"TestRepo\\"\\n },\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"gmtCreate\\": 1621578648000,\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"85702b33f14bfa82cb458173ba\\",\\n \\"value\\": \\"d7f112f9d023e2108fa1b0d8\\",\\n \\"fieldFormat\\": \\"Input\\",\\n \\"fieldClassName\\": \\"User\\"\\n }\\n ],\\n \\"tags\\": [\\n {\\n \\"tagIdentifier\\": \\"85702b33f14bxxxxxx58173ba\\",\\n \\"name\\": \\"标签名称\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取用例库测试用例列表', + 'description' => '获取测试用例库中的测试用例列表，支持条件过滤，使用conditions条件过滤相应的数据', + ], + 'UpdateTestResult' => [ + 'summary' => '更新测试计划中的用例的执行状态和执行人', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresult/{testcaseIdentifier}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testPlanIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '测试计划ID，测试计划唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '1d79xxxxxx86181xx6c5b', + ], + ], + [ + 'name' => 'testcaseIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '测试用例id，测试用例在用例库中的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '4e22xxxxxxxxc64c16037fe76', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'executor' => [ + 'title' => '测试计划中测试用例更新需要的执行人字段', + 'description' => '测试计划中测试用例更新需要的执行人字段', + 'type' => 'string', + 'required' => false, + 'example' => '131xxx38624xxxx68', + ], + 'status' => [ + 'title' => '测试计划中测试用例更新需要的状态字段', + 'description' => '测试计划中测试用例更新需要的状态字段', + 'type' => 'string', + 'required' => false, + 'example' => 'TO DO', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false，是否更新成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '更新测试计划中测试用例结果', + 'description' => '更新测试计划中的用例的执行状态和执行人', + ], + 'GetTestResultList' => [ + 'summary' => '获取测试计划中测试用例列表，支持使用条件过滤', + 'path' => '/organization/{organizationId}/testhub/testplan/{testPlanIdentifier}/testresults', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'testPlanIdentifier', + 'in' => 'path', + 'schema' => [ + 'description' => '测试计划id，测试计划唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '592531xxxxxx15f2e98dbc7e27', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'directoryIdentifier' => [ + 'title' => '目录唯一标识，测试计划中对应的目录id', + 'description' => '目录唯一标识，测试计划中对应的目录id', + 'type' => 'string', + 'required' => true, + 'example' => 'e27b8eace6501ce51cf5d56784', + ], + 'conditions' => [ + 'title' => '过滤器条件', + 'description' => '过滤器条件', + 'type' => 'string', + 'required' => false, + 'example' => '{\'conditionGroups\': [[{\'fieldIdentifier\': \'gmtModified\', \'operator\': \'MORE_THAN_AND_EQUAL\', \'value\': [\'2023-04-20 18:03:12.442140\'], \'className\': \'dateTime\', \'format\': \'input\'}]]}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => 'true或者false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'testResult' => [ + 'title' => '工作项信息', + 'description' => '工作项信息', + 'type' => 'array', + 'items' => [ + 'description' => '测试结果内容', + 'type' => 'object', + 'properties' => [ + 'testResultIdentifier' => [ + 'title' => '测试结果的id', + 'description' => '测试结果的id', + 'type' => 'string', + 'example' => 'a8bxxxxxxxxxxxxxxxx54', + ], + 'testResultStatus' => [ + 'title' => '测试结果的状态', + 'description' => '测试结果的状态', + 'type' => 'string', + 'example' => 'TO DO', + ], + 'testResultExecutor' => [ + 'title' => '测试计划执行人对象', + 'description' => '测试计划执行人对象', + 'type' => 'object', + 'properties' => [ + 'executorIdentifier' => [ + 'title' => '执行人唯一标识，aliyunPk', + 'description' => '执行人唯一标识，aliyunPk', + 'type' => 'string', + 'example' => '1243xxxxx234xx', + ], + 'name' => [ + 'title' => '执行人名称', + 'description' => '执行人名称', + 'type' => 'string', + 'example' => '人员名称', + ], + ], + ], + 'testResultGmtCreate' => [ + 'description' => '测试结果生成时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1621578648000'."\n", + ], + 'testcaseIdentifier' => [ + 'description' => '测试用例id，测试用例唯一标识', + 'type' => 'string', + 'example' => '943d20fe5e385a08fdd6b593fb', + ], + 'bugCount' => [ + 'description' => '测试执行结果关联缺陷数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'subject' => [ + 'title' => '测试用例标题', + 'description' => '测试用例标题', + 'type' => 'string', + 'example' => '测试工作项', + ], + 'assignedTo' => [ + 'title' => '负责人信息', + 'description' => '负责人信息', + 'type' => 'object', + 'properties' => [ + 'assignedToIdenttifier' => [ + 'title' => '负责人id，负责人唯一标识', + 'description' => '负责人id，负责人唯一标识', + 'type' => 'string', + 'example' => '1243xxxxx234xx', + ], + 'name' => [ + 'title' => '负责人姓名', + 'description' => '负责人姓名', + 'type' => 'string', + 'example' => '人员名称', + ], + ], + ], + 'spaceIdentifier' => [ + 'title' => '测试用例所属的测试库id', + 'description' => '测试用例所属的测试库id', + 'type' => 'string', + 'example' => '592531647d7b15f2e98dbc7e27', + ], + 'categoryIdentifier' => [ + 'title' => '测试用例的类型id', + 'description' => '测试用例的类型id', + 'type' => 'string', + 'example' => 'Req', + ], + 'gmtCreate' => [ + 'title' => '测试用例创建时间', + 'description' => '测试用例创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1621578648000', + ], + 'customFields' => [ + 'title' => '自定义字段数组', + 'description' => '自定义字段数组', + 'type' => 'array', + 'items' => [ + 'description' => '字段值，写入时使用', + 'type' => 'object', + 'properties' => [ + 'fieldIdentifier' => [ + 'title' => '字段id，自定义字段唯一标识', + 'description' => '字段id，自定义字段唯一标识', + 'type' => 'string', + 'example' => '943d20fe5e385a08fdd6b593fb', + ], + 'value' => [ + 'title' => '自定义字段值', + 'description' => '自定义字段值', + 'type' => 'string', + 'example' => 'd7f112f9d023e2108fa1b0d8', + ], + 'fieldFormat' => [ + 'title' => '自定义字段格式', + 'description' => '自定义字段格式', + 'type' => 'string', + 'example' => 'Input', + ], + 'fieldClassName' => [ + 'title' => '自定义字段类型', + 'description' => '自定义字段类型', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Openapi.RequestError', + 'errorMessage' => 'request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'Operate.NoPermission', + 'errorMessage' => 'NoPermission', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"errorMsg\\": \\"error\\",\\n \\"errorCode\\": \\"Openapi.RequestError\\",\\n \\"success\\": true,\\n \\"testResult\\": [\\n {\\n \\"testResultIdentifier\\": \\"a8bxxxxxxxxxxxxxxxx54\\",\\n \\"testResultStatus\\": \\"TO DO\\",\\n \\"testResultExecutor\\": {\\n \\"executorIdentifier\\": \\"1243xxxxx234xx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"testResultGmtCreate\\": 1621578648000,\\n \\"testcaseIdentifier\\": \\"943d20fe5e385a08fdd6b593fb\\",\\n \\"bugCount\\": 8,\\n \\"subject\\": \\"测试工作项\\",\\n \\"assignedTo\\": {\\n \\"assignedToIdenttifier\\": \\"1243xxxxx234xx\\",\\n \\"name\\": \\"人员名称\\"\\n },\\n \\"spaceIdentifier\\": \\"592531647d7b15f2e98dbc7e27\\",\\n \\"categoryIdentifier\\": \\"Req\\",\\n \\"gmtCreate\\": 1621578648000,\\n \\"customFields\\": [\\n {\\n \\"fieldIdentifier\\": \\"943d20fe5e385a08fdd6b593fb\\",\\n \\"value\\": \\"d7f112f9d023e2108fa1b0d8\\",\\n \\"fieldFormat\\": \\"Input\\",\\n \\"fieldClassName\\": \\"User\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取测试计划中测试用例列表', + 'description' => '获取测试计划中测试用例列表，支持使用条件过滤，使用condtion字段', + ], + 'ExportWorkitemActivity' => [ + 'summary' => '获取效能洞察中指定企业的workitem_activity表数据', + 'path' => '/organization/{organizationId}/data/workitemActivities', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00', + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00', + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数，最大值10000', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_activity', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'newValue' => [ + 'title' => '新值', + 'description' => '新值', + 'type' => 'string', + 'example' => '1', + ], + 'oldValue' => [ + 'title' => '旧值', + 'description' => '旧值', + 'type' => 'string', + 'example' => '2', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '2a62349afcbef7f23d8f31xxxx', + ], + 'source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'projex', + ], + 'type' => [ + 'title' => '事件类型', + 'description' => '事件类型', + 'type' => 'string', + 'example' => 'workitem.update.priority', + ], + 'workitemId' => [ + 'title' => '工作项ID', + 'description' => '工作项ID', + 'type' => 'string', + 'example' => 'ec69eae498acce08ff7260xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 4406380356,\\n \\"gmtEvent\\": 1714961337000,\\n \\"identifier\\": \\"254662353\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"newValue\\": \\"1\\",\\n \\"oldValue\\": \\"2\\",\\n \\"projectId\\": \\"2a62349afcbef7f23d8f31xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"type\\": \\"workitem.update.priority\\",\\n \\"workitemId\\": \\"ec69eae498acce08ff7260xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出WorkitemActivity', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightWorkitemVersion' => [ + 'summary' => '获取效能洞察中指定企业的workitem_version表数据', + 'path' => '/organization/{organizationId}/data/workitemVersions', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'workitem_version', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'name' => [ + 'title' => '版本名称', + 'description' => '版本名称', + 'type' => 'string', + 'example' => '版本0501', + ], + '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' => '版本状态，10/50/100 -> TODO/DOING/ARCHIVED', + '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' => '所属空间类型id', + 'type' => 'string', + 'example' => '7eee44ec7f699d4e6980faxxxx', + ], + 'source' => [ + 'title' => '来源（projex/teambition）', + 'description' => '来源（projex/teambition）', + 'type' => 'string', + 'example' => 'projex', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 648131,\\n \\"gmtCreate\\": 1704251228000,\\n \\"gmtModified\\": 1704251228000,\\n \\"identifier\\": \\"7ba6e8261b973c976df76b7de1\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"name\\": \\"版本0501\\",\\n \\"gmtStart\\": 1704297600000,\\n \\"gmtPublish\\": 1704902400000,\\n \\"status\\": 100,\\n \\"lockStatus\\": 0,\\n \\"targetType\\": \\"Project\\",\\n \\"targetId\\": \\"7eee44ec7f699d4e6980faxxxx\\",\\n \\"source\\": \\"projex\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出WorkitemVersion', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightWorkitemStatusJoinWorkitemDefectExtra' => [ + 'summary' => '获取效能洞察中指定企业的workitem_status表 join worktem_defect_extra表数据', + 'path' => '/organization/{organizationId}/data/workitemStatusJoinWorkitemDefectExtras', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + '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' => '记录自增Id', + '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' => '需求ID（工作项ID）', + 'type' => 'string', + 'example' => '636f661a612a945bbcdb4cxxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'assignedToId' => [ + 'title' => '指派人ID', + 'description' => '指派人ID', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '创建人ID', + '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' => '是否归档(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'isDone' => [ + 'title' => '是否已完成（Y|N）', + 'description' => '是否已完成（Y|N）', + 'type' => 'string', + 'example' => 'Y', + ], + 'parentId' => [ + 'title' => '父工作项ID', + 'description' => '父工作项ID', + 'type' => 'string', + 'example' => 'a80a203a9078a7a1b1f2c6xxxx', + ], + 'participantIds' => [ + 'title' => '参与人ID列表（逗号分隔）', + 'description' => '参与人ID列表（逗号分隔）', + 'type' => 'string', + 'example' => '6135b21fb383ef39551cf02e,63466a385dc8531eebd764e9', + ], + 'phase' => [ + 'title' => '大阶段（10-100）,对应todo、doing、done', + 'description' => '大阶段（10-100）,对应todo、doing、done', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'stage' => [ + 'title' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'description' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'priority' => [ + 'title' => '优先级（0-9）', + 'description' => '优先级（0-9）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'productId' => [ + 'title' => '产品ID', + 'description' => '产品ID', + 'type' => 'string', + 'example' => '无', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '6732a29d846bf998dc09e7xxxx', + ], + 'source' => [ + 'title' => '来源 teambition/projex', + 'description' => '来源 teambition/projex', + 'type' => 'string', + 'example' => 'projex', + ], + 'sprintId' => [ + 'title' => '迭代ID', + 'description' => '迭代ID', + 'type' => 'string', + 'example' => '731c83a40bbf3c2f080e07xxxx', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusId' => [ + 'title' => '状态id', + 'description' => '状态id', + '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' => '版本ID', + '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' => 'extra表自增id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'foundPhase' => [ + 'title' => '发现阶段（10-100）', + 'description' => '发现阶段（10-100）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'gmtFixed' => [ + 'title' => '实际修复时间（秒）', + 'description' => '实际修复时间（秒）', + 'type' => 'string', + 'example' => '无', + ], + 'isStupid' => [ + 'title' => '是否低级错误（Y|N）', + 'description' => '是否低级错误（Y|N）', + 'type' => 'string', + 'example' => '无', + ], + 'reopenNum' => [ + 'title' => '重复开启次数', + 'description' => '重复开启次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '无', + ], + 'seriousLevel' => [ + 'title' => '严重程度（0-9）', + 'description' => '严重程度（0-9）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '无', + ], + 'solution' => [ + 'title' => '解决方法类型', + 'description' => '解决方法类型', + 'type' => 'string', + 'example' => '无', + ], + 'extraIsDeleted' => [ + 'title' => 'extra是否删除(归档)字段, Y(删除或归档) / N(正常)', + 'description' => 'extra是否删除(归档)字段, Y(删除或归档) / N(正常)', + 'type' => 'string', + 'example' => 'N', + ], + 'verifierId' => [ + 'title' => '验证者id', + 'description' => '验证者id', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'serialNumber' => [ + 'title' => '在空间内的编号', + 'description' => '在空间内的编号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '导出WorkitemStatus和WorkitemDefectExtra', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightWorkitemStatus' => [ + 'summary' => '获取效能洞察中指定企业的workitem_status表数据', + 'path' => '/organization/{organizationId}/data/workitemStatuses', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + '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' => '记录自增Id', + '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' => '需求ID（工作项ID）', + 'type' => 'string', + 'example' => '636f661a612a945bbcdb4cxxxx', + ], + 'isDeleted' => [ + 'title' => '是否删除(Y|N)', + 'description' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'assignedToId' => [ + 'title' => '指派人ID', + 'description' => '指派人ID', + 'type' => 'string', + 'example' => '65e836b981d758be7a25xxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '创建人ID', + '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' => '是否归档(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'isDone' => [ + 'title' => '是否已完成（Y|N）', + 'description' => '是否已完成（Y|N）', + 'type' => 'string', + 'example' => 'Y', + ], + 'parentId' => [ + 'title' => '父工作项ID', + 'description' => '父工作项ID', + 'type' => 'string', + 'example' => 'c3640ab6233fcc10a7e3aaxxxx', + ], + 'participantIds' => [ + 'title' => '参与人ID列表（逗号分隔）', + 'description' => '参与人ID列表（逗号分隔）', + 'type' => 'string', + 'example' => '6135b21fb383ef39551cxxxx,63466a385dc8531eebd7xxxx', + ], + 'phase' => [ + 'title' => '大阶段（10-100）,对应todo、doing、done', + 'description' => '大阶段（10-100）,对应todo、doing、done', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'stage' => [ + 'title' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'description' => '小阶段（10-100）,对应projex的确认阶段、分析阶段、处理阶段、设计阶段、开发阶段等', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'priority' => [ + 'title' => '优先级（0-9）', + 'description' => '优先级（0-9）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'productId' => [ + 'title' => '产品ID', + 'description' => '产品ID', + 'type' => 'string', + 'example' => '无', + ], + 'projectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '505ac6433dfbda8df0b08bxxxx', + ], + 'source' => [ + 'title' => '来源 teambition/projex', + 'description' => '来源 teambition/projex', + 'type' => 'string', + 'example' => 'projex', + ], + 'sprintId' => [ + 'title' => '迭代ID', + 'description' => '迭代ID', + 'type' => 'string', + 'example' => '505ac6433dfbda8df0b08bxxxx', + ], + 'status' => [ + 'title' => '状态名称', + 'description' => '状态名称', + 'type' => 'string', + 'example' => '待处理', + ], + 'statusId' => [ + 'title' => '状态id', + 'description' => '状态id', + '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' => '版本ID', + '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' => '在空间内的编号', + 'description' => '在空间内的编号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '导出WorkitemStatus', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightWorkTime' => [ + 'summary' => '获取效能洞察中指定企业的workitem_time表数据', + 'path' => '/organization/{organizationId}/data/workTimes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'work_time', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'recorderId' => [ + 'title' => '工时填报人', + 'description' => '工时填报人', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'source' => [ + 'title' => '来源: Projex or Teambition', + 'description' => '来源: Projex or Teambition', + 'type' => 'string', + 'example' => 'projex', + ], + 'value' => [ + 'title' => '填报时长', + 'description' => '填报时长，单位小时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'workitemId' => [ + 'title' => '需求ID（工作项ID）', + 'description' => '需求ID（工作项ID）', + 'type' => 'string', + 'example' => '17bc1cf9a037a15fc9ce76xxxx', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '项目id', + 'type' => 'string', + 'example' => '09670872890eb1a0bb998exxxx', + ], + 'type' => [ + 'title' => '实际工时类别', + 'description' => '实际工时类别', + 'type' => 'string', + 'example' => '研发', + ], + 'gmtStart' => [ + 'title' => '实际工时-开始时间', + 'description' => '实际工时-开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714924800000', + ], + 'gmtEnd' => [ + 'title' => '实际工时-结束时间', + 'description' => '实际工时-结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715011199999', + ], + 'uuid' => [ + 'title' => '工时拆分后的唯一标识', + 'description' => '工时拆分后的唯一标识', + 'type' => 'string', + 'example' => '000000000cd82d3df50d5e5a5c094094fd7b4461', + ], + 'actualValue' => [ + 'title' => '工时拆分后的值', + 'description' => '工时拆分后的值，单位小时', + 'type' => 'number', + 'format' => 'double', + 'example' => '120', + ], + 'description' => [ + 'title' => '工时描述', + 'description' => '工时描述', + 'type' => 'string', + 'example' => '描述信息', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 49506082,\\n \\"gmtCreate\\": 1714978610000,\\n \\"gmtModified\\": 1714978610000,\\n \\"identifier\\": \\"da70ce5824231ca3c04ef808e0\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"recorderId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"value\\": 120,\\n \\"workitemId\\": \\"17bc1cf9a037a15fc9ce76xxxx\\",\\n \\"projectId\\": \\"09670872890eb1a0bb998exxxx\\",\\n \\"type\\": \\"研发\\",\\n \\"gmtStart\\": 1714924800000,\\n \\"gmtEnd\\": 1715011199999,\\n \\"uuid\\": \\"000000000cd82d3df50d5e5a5c094094fd7b4461\\",\\n \\"actualValue\\": 120,\\n \\"description\\": \\"描述信息\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出WorkTime', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightTagRef' => [ + 'summary' => '获取效能洞察中指定企业的tag_ref表数据', + 'path' => '/organization/{organizationId}/data/tagRefs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数，最大值10000', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'tag_ref', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'name' => [ + 'title' => '标签名字', + 'description' => '标签名字', + 'type' => 'string', + 'example' => '1', + ], + 'tagId' => [ + 'title' => '标签本身唯一标识', + 'description' => '标签本身唯一标识', + 'type' => 'string', + 'example' => '19e0bc5348ccbe6c0d00fbxxxx', + ], + 'targetId' => [ + 'title' => '打标对象的资源id', + 'description' => '打标对象的资源id', + 'type' => 'string', + 'example' => 'bde89961b5a4acc8cf54eaxxxx', + ], + 'targetType' => [ + 'title' => '打标对象的资源类型，如workitem space code', + 'description' => '打标对象的资源类型，如workitem space code', + 'type' => 'string', + 'example' => 'Workitem', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 41317426,\\n \\"gmtCreate\\": 1696660187000,\\n \\"gmtModified\\": 1696660187000,\\n \\"identifier\\": \\"8545272\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"name\\": \\"1\\",\\n \\"tagId\\": \\"19e0bc5348ccbe6c0d00fbxxxx\\",\\n \\"targetId\\": \\"bde89961b5a4acc8cf54eaxxxx\\",\\n \\"targetType\\": \\"Workitem\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出TagRef', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightSprint' => [ + 'summary' => '获取效能洞察中指定企业的sprint表数据', + 'path' => '/organization/{organizationId}/data/sprints', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + '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' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + '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' => '迭代0601', + ], + 'source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'projex', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '项目id', + 'type' => 'string', + 'example' => '385e7e5a4be6791f0a5185xxxx', + ], + 'workTimeCapacity' => [ + 'title' => '工时容量评估字段', + 'description' => '工时容量评估字段', + 'type' => 'number', + 'format' => 'double', + 'example' => '60.0', + ], + 'status' => [ + 'title' => '迭代状态：待开始，进行中，已完成/关闭', + 'description' => '迭代状态：待开始（10），进行中（50），已完成/关闭（100）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"gmtCreate\\": 1710989643000,\\n \\"id\\": 18471761,\\n \\"gmtModified\\": 1711936113000,\\n \\"identifier\\": \\"e4895cadc86632f34dfaa7xxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"gmtEnd\\": 1711728000000,\\n \\"gmtStart\\": 1711936113000,\\n \\"actualStart\\": 1711936113000,\\n \\"actualEnd\\": 1711936113000,\\n \\"name\\": \\"迭代0601\\",\\n \\"source\\": \\"projex\\",\\n \\"projectId\\": \\"385e7e5a4be6791f0a5185xxxx\\",\\n \\"workTimeCapacity\\": 60,\\n \\"status\\": 50\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出Sprint', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightSpaceRef' => [ + 'summary' => '获取效能洞察中指定企业的space_ref表数据', + 'path' => '/organization/{organizationId}/data/spaceRefs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'space_ref', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'creatorId' => [ + 'title' => '创建人ID', + 'description' => '创建人ID', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'modifierId' => [ + 'title' => '修改人ID', + 'description' => '修改人ID', + 'type' => 'string', + 'example' => '65659358c319d2a0f912xxxx', + ], + 'fromId' => [ + 'title' => '源空间id', + 'description' => '源空间id', + 'type' => 'string', + 'example' => '7bc2be989727d0d4c9801fxxxx', + ], + 'toId' => [ + 'title' => '目标空间id', + 'description' => '目标空间id', + 'type' => 'string', + 'example' => '732026500a48d7a74f8b43xxxx', + ], + 'type' => [ + 'title' => '关联类型：项目集关联项目ASSOCIATED', + 'description' => '关联类型：项目集关联项目ASSOCIATED', + 'type' => 'string', + 'example' => 'ASSOCIATED', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 356525,\\n \\"gmtCreate\\": 1704267849000,\\n \\"gmtModified\\": 1704267849000,\\n \\"identifier\\": \\"49565\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"creatorId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"modifierId\\": \\"65659358c319d2a0f912xxxx\\",\\n \\"fromId\\": \\"7bc2be989727d0d4c9801fxxxx\\",\\n \\"toId\\": \\"732026500a48d7a74f8b43xxxx\\",\\n \\"type\\": \\"ASSOCIATED\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出SpaceRef', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightSpace' => [ + 'summary' => '获取效能洞察中指定企业的space表数据', + 'path' => '/organization/{organizationId}/data/spaces', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'space', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + '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' => '自定义编号', + 'description' => '自定义编号', + 'type' => 'string', + 'example' => 'ABCD', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '导出Space', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightField' => [ + 'summary' => '获取效能洞察中指定企业的field表数据', + 'path' => '/organization/{organizationId}/data/fields', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + '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' => '记录自增Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666666', + ], + 'fieldId' => [ + 'title' => '字段id，如自定义字段Id及标签id', + 'description' => '字段id，如自定义字段Id及标签id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'isSystem' => [ + 'title' => '是否系统字段(Y|N)', + 'description' => '是否系统字段(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'optionValue' => [ + 'title' => '字段可选值列表，如枚举有可选值', + 'description' => '字段可选值列表，如枚举有可选值', + 'type' => 'string', + 'example' => '"[\\"是\\"]"', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'targetId' => [ + 'title' => '字段适用对象id, 如项目id, 企业id', + 'description' => '字段适用对象id, 如项目id, 企业id', + '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' => '字段范围，space/global/system -> 项目内/全局/系统', + 'type' => 'string', + 'example' => 'global', + ], + 'source' => [ + 'title' => '字段来源系统，如projex/teambition', + 'description' => '字段来源系统，如projex/teambition', + 'type' => 'string', + 'example' => 'projex', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 666666,\\n \\"fieldId\\": \\"9798551\\",\\n \\"fieldName\\": \\"多选字段\\",\\n \\"gmtCreate\\": 1713752162000,\\n \\"gmtModified\\": 1714977502000,\\n \\"identifier\\": \\"field-444153\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"isSystem\\": \\"N\\",\\n \\"optionValue\\": \\"\\\\\\"[\\\\\\\\\\\\\\"是\\\\\\\\\\\\\\"]\\\\\\"\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetType\\": \\"organization\\",\\n \\"type\\": \\"string\\",\\n \\"position\\": 150,\\n \\"scope\\": \\"global\\",\\n \\"source\\": \\"projex\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出Field', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightExpectedWorkTime' => [ + 'summary' => '获取效能洞察中指定企业的expected_work_time表数据', + 'path' => '/organization/{organizationId}/data/expectedWorkTimes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数，最大值10000', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'expected_work_time', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N'."\n", + ], + 'organizationId' => [ + 'title' => '租户隔离ID', + 'description' => '租户隔离ID', + 'type' => 'string', + 'example' => '61db9af2148974246be6xxxx', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '项目id', + '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' => '工作项ID', + 'type' => 'string', + 'example' => 'de7c6fd3bd4b53f4d9e279xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 26281535,\\n \\"gmtCreate\\": 1714976497000,\\n \\"gmtModified\\": 1714976520000,\\n \\"identifier\\": \\"bd4ddc7b0ea0ef2ab52699xxxx\\",\\n \\"isDeleted\\": \\"N\\\\n\\",\\n \\"organizationId\\": \\"61db9af2148974246be6xxxx\\",\\n \\"projectId\\": \\"6c4687b0179e1d458fedf1xxxx\\",\\n \\"recorderId\\": \\"63466a385dc8531eebd7xxxx\\",\\n \\"source\\": \\"projex\\",\\n \\"type\\": \\"产品\\",\\n \\"value\\": 180,\\n \\"workitemId\\": \\"de7c6fd3bd4b53f4d9e279xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出ExpectedWorkTime', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'ExportInsightCustomValue' => [ + 'summary' => '获取效能洞察中指定企业的custom_value表数据', + 'path' => '/organization/{organizationId}/data/customValues', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/#{organizationId}', + 'type' => 'string', + 'required' => true, + 'example' => '61db9af2148974246bexxxx'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'startTime' => [ + 'title' => '开始时间。和结束时间间隔不超过1年。', + 'description' => '开始时间。和结束时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05-01 00:00:00'."\n", + ], + 'endTime' => [ + 'title' => '结束时间。和开始时间间隔不超过1年。', + 'description' => '结束时间。和开始时间间隔不超过1年。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-06-01 00:00:00'."\n", + ], + 'nextToken' => [ + 'title' => '下一页token', + 'description' => '下一页token', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'maxResults' => [ + 'title' => '最大结果条数', + 'description' => '最大结果条数，最大值10000', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'nextToken' => [ + 'title' => '下一页token，为null表示没有下一页', + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => '2', + ], + 'maxResults' => [ + 'title' => '返回条数', + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => 'custom_value', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录自增Id', + 'description' => '记录自增Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '320737507', + ], + 'fieldId' => [ + 'title' => '字段id，如自定义字段Id及标签id', + 'description' => '字段id，如自定义字段Id及标签id', + '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' => '是否删除(Y|N)', + 'type' => 'string', + 'example' => 'N', + ], + 'organizationId' => [ + 'title' => '企业id', + 'description' => '企业id', + 'type' => 'string', + 'example' => '61db9af2148974246bexxxx', + ], + 'targetId' => [ + 'title' => '关联对象的资源id', + 'description' => '关联对象的资源id', + 'type' => 'string', + 'example' => '1ee00fcb1a18c2dc83dafdxxxx', + ], + 'targetType' => [ + 'title' => '关联对象的资源类型，如workitem space code', + 'description' => '关联对象的资源类型，如workitem space code', + 'type' => 'string', + 'example' => 'Workitem', + ], + 'type' => [ + 'title' => '自定义字段值类型', + 'description' => '自定义字段值类型', + 'type' => 'string', + 'example' => 'string', + ], + 'value' => [ + 'description' => '值', + 'type' => 'string', + 'example' => '66', + ], + 'doubleValue' => [ + 'title' => 'double值', + 'description' => 'double值', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.6', + ], + 'longValue' => [ + 'title' => 'long值', + 'description' => 'long值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 10,\\n \\"result\\": [\\n {\\n \\"id\\": 320737507,\\n \\"fieldId\\": \\"34dde3dfa5e3750151a7c4xxxx\\",\\n \\"gmtCreate\\": 1704950971000,\\n \\"gmtModified\\": 1714669494000,\\n \\"identifier\\": \\"442d4a6a9980e841dc192a411080xxxx\\",\\n \\"isDeleted\\": \\"N\\",\\n \\"organizationId\\": \\"61db9af2148974246bexxxx\\",\\n \\"targetId\\": \\"1ee00fcb1a18c2dc83dafdxxxx\\",\\n \\"targetType\\": \\"Workitem\\",\\n \\"type\\": \\"string\\",\\n \\"value\\": \\"66\\",\\n \\"doubleValue\\": 66.6,\\n \\"longValue\\": 66\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导出CustomValue', + 'description' => '效能洞察数据导出API仅面向高级版客户开放，了解云效高级版功能，请前往 [https://help.aliyun.com/document_detail/173288.html](https://help.aliyun.com/document_detail/173288.html)', + ], + 'UpdateOrganizationMember' => [ + 'summary' => '更新企业成员信息。', + 'path' => '/organization/{organizationId}/members/{accountId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '云效企业ID', + 'type' => 'string', + 'required' => true, + 'example' => '5ebbc0228123212b59xxxxx', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '云账号ID', + 'type' => 'string', + 'required' => true, + 'example' => '243721251830762xxx', + ], + ], + [ + 'name' => 'organizationMemberName', + 'in' => 'query', + 'schema' => [ + 'description' => '企业成员名', + 'type' => 'string', + 'required' => true, + 'example' => '名字1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ApiGenericResult', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7B85D1B-D1C2-140F-A039-341859F130B9', + ], + 'errorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '""', + ], + 'member' => [ + 'description' => '成员信息', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '292035769476261xxx', + ], + 'organizationMemberName' => [ + 'description' => '企业成员名', + 'type' => 'string', + 'example' => '名字1', + ], + ], + ], + 'success' => [ + 'description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The user that is invoking the API service is not a registered user.', + ], + [ + 'errorCode' => 'InvalidParam.ParamNotPresent', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParam.NoPermission', + 'errorMessage' => 'param value is not permission.', + ], + ], + [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The current user is not in the organization and has no permission to operate.', + ], + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F7B85D1B-D1C2-140F-A039-341859F130B9\\",\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"member\\": {\\n \\"accountId\\": \\"292035769476261xxx\\",\\n \\"organizationMemberName\\": \\"名字1\\"\\n },\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '更新企业成员信息', + ], + 'ListOrganizationMembers' => [ + 'summary' => '根据指定条件获取企业成员信息。', + 'path' => '/organization/{organizationId}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'organizationMemberName', + 'in' => 'query', + 'schema' => [ + 'description' => '企业成员名', + 'type' => 'string', + 'required' => false, + 'example' => '名字1', + ], + ], + [ + 'name' => 'provider', + 'in' => 'query', + 'schema' => [ + 'description' => '第三方系统（若是钉钉同步，则是 Dingtalk）， 与externUid参数成对使用，只传其中一个，不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Dingtalk', + ], + ], + [ + 'name' => 'externUid', + 'in' => 'query', + 'schema' => [ + 'description' => '第三方系统的用户 id：若是钉钉同步，则是钉钉的员工 User ID；与provider参数成对使用，只传其中一个，不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1236666', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'description' => '选项：正常（normal），已停用（blocked），已删除（deleted），只能指定一种；若不指定，默认返回正常（normal）状态的成员。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页中的起始序列，值为上一页请求返回的nextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回数量，0-50，默认值20', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'joinTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '加入云效企业时间，单位为毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1631845101798', + ], + ], + [ + 'name' => 'joinTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '加入云效企业时间，单位为毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1631845101798', + ], + ], + [ + 'name' => 'containsExternInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '返回信息中是否包含第三方信息，默认不包含。', + 'description' => '返回信息中是否包含第三方信息，默认不包含。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'errorMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'error info', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'null', + ], + 'nextToken' => [ + 'title' => '分页Token', + 'description' => '分页Token', + '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' => '阿里云用户UID', + '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' => '[email protected]', + ], + 'hiredDate' => [ + 'title' => '入职时间', + 'description' => '入职时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'identities' => [ + 'title' => '第三方信息', + 'description' => '第三方信息', + 'type' => 'object', + 'properties' => [ + 'externUid' => [ + 'title' => '第三方系统的用户Id', + 'description' => '第三方系统的用户Id', + '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' => '1390000****', + ], + 'organizationMemberName' => [ + 'title' => '企业成员名', + 'description' => '企业成员名', + 'type' => 'string', + 'example' => '名字1', + ], + 'organizationRoleName' => [ + 'title' => '企业角色名字', + 'description' => '企业角色名字', + 'type' => 'string', + 'example' => '管理员', + ], + 'organizationRoleId' => [ + 'title' => '企业角色Id', + 'description' => '企业角色Id', + 'type' => 'string', + 'example' => '8fc0c9ff039711dd64acd000', + ], + 'state' => [ + 'title' => '用户状态', + 'description' => '用户状态（正常（normal），已停用（blocked），已删除（deleted）)', + 'type' => 'string', + 'example' => 'normal', + ], + 'jobNumber' => [ + 'description' => '工号', + 'type' => 'string', + 'example' => '373***', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParam.NoPermission', + 'errorMessage' => 'No Permission.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"error info\\",\\n \\"success\\": true,\\n \\"errorCode\\": \\"null\\",\\n \\"nextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"totalCount\\": 15,\\n \\"members\\": [\\n {\\n \\"accountId\\": \\"123456677888\\",\\n \\"birthday\\": 1631845101798,\\n \\"deptLists\\": [\\n \\"测试部门\\"\\n ],\\n \\"email\\": \\"[email protected]\\",\\n \\"hiredDate\\": 1631845101798,\\n \\"identities\\": {\\n \\"externUid\\": \\"1236666\\",\\n \\"provider\\": \\"Dingtalk\\"\\n },\\n \\"joinTime\\": 1631845101798,\\n \\"lastVisitTime\\": 1631845101798,\\n \\"mobile\\": \\"1390000****\\",\\n \\"organizationMemberName\\": \\"名字1\\",\\n \\"organizationRoleName\\": \\"管理员\\",\\n \\"organizationRoleId\\": \\"8fc0c9ff039711dd64acd000\\",\\n \\"state\\": \\"normal\\",\\n \\"jobNumber\\": \\"373***\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListOrganizationMembersResponse>\\n <requestId>FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <errorMessage>error info</errorMessage>\\n <success>true</success>\\n <errorCode>null</errorCode>\\n <nextToken>\\"\\"</nextToken>\\n <totalCount>15</totalCount>\\n <members>\\n <accountId>123456677888</accountId>\\n <birthday>1631845101798</birthday>\\n <deptLists>测试部门</deptLists>\\n <email>[email protected]</email>\\n <hiredDate>1631845101798</hiredDate>\\n <identities>\\n <externUid>1236666</externUid>\\n <provider>Dingtalk</provider>\\n </identities>\\n <joinTime>1631845101798</joinTime>\\n <lastVisitTime>1631845101798</lastVisitTime>\\n <mobile>1390000****</mobile>\\n <organizationMemberName>名字1</organizationMemberName>\\n <organizationRoleName>管理员</organizationRoleName>\\n <organizationRoleId>8fc0c9ff039711dd64acd000</organizationRoleId>\\n <state>normal</state>\\n </members>\\n</ListOrganizationMembersResponse>","errorExample":""}]', + 'title' => '查询企业成员信息列表', + ], + 'GetOrganizationMember' => [ + 'summary' => '根据指定条件获取企业成员信息。', + 'path' => '/organization/{organizationId}/members/{accountId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'path', + 'schema' => [ + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'accountId', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云用户UID', + 'type' => 'string', + 'required' => true, + 'example' => '123456677888', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + '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' => '阿里云用户UID', + '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' => '[email protected]', + ], + 'hiredDate' => [ + 'title' => '入职时间', + 'description' => '入职时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631845101798', + ], + 'identities' => [ + 'title' => '第三方信息', + 'description' => '第三方信息', + 'type' => 'object', + 'properties' => [ + 'externUid' => [ + 'title' => '第三方系统的用户 id', + 'description' => '第三方系统的用户 id', + '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' => '1390000****', + ], + 'organizationMemberName' => [ + 'title' => '企业成员名', + 'description' => '企业成员名', + 'type' => 'string', + 'example' => '名字1', + ], + 'organizationRoleName' => [ + 'title' => '企业角色名字', + 'description' => '企业角色名字', + 'type' => 'string', + 'example' => '管理员', + ], + 'jobNumber' => [ + 'description' => '工号', + 'type' => 'string', + 'example' => '373***', + ], + 'organizationRoleId' => [ + 'title' => '企业角色Id', + 'description' => '企业角色Id', + 'type' => 'string', + 'example' => '8fc0c9ff039711dd64acd000', + ], + 'state' => [ + 'title' => '用户状态', + 'description' => '用户状态（正常（normal），已停用（blocked），已删除（deleted））', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'null', + ], + 'success' => [ + 'title' => 'true 接口调用成功，false 接口调用失败', + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUser.UserNotInCurrentOrganization', + 'errorMessage' => 'The user is not in the organization.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.UserNotAdminOrOwner', + 'errorMessage' => 'The current user is not an admin or owner in the organization and is not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidOrganization.NotFound', + 'errorMessage' => 'The organization is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"errorMessage\\": \\"error info\\",\\n \\"member\\": {\\n \\"accountId\\": \\"123456677888\\",\\n \\"birthday\\": 1631845101798,\\n \\"deptLists\\": [\\n \\"测试部门\\"\\n ],\\n \\"email\\": \\"[email protected]\\",\\n \\"hiredDate\\": 1631845101798,\\n \\"identities\\": {\\n \\"externUid\\": \\"1236666\\",\\n \\"provider\\": \\"Dingtalk\\"\\n },\\n \\"joinTime\\": 1631845101798,\\n \\"lastVisitTime\\": 1631845101798,\\n \\"mobile\\": \\"1390000****\\",\\n \\"organizationMemberName\\": \\"名字1\\",\\n \\"organizationRoleName\\": \\"管理员\\",\\n \\"jobNumber\\": \\"373***\\",\\n \\"organizationRoleId\\": \\"8fc0c9ff039711dd64acd000\\",\\n \\"state\\": \\"normal\\"\\n },\\n \\"errorCode\\": \\"null\\",\\n \\"success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOrganizationMemberResponse>\\n <requestId>HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F</requestId>\\n <errorMessage>error info</errorMessage>\\n <member>\\n <accountId>123456677888</accountId>\\n <birthday>1631845101798</birthday>\\n <deptLists>测试部门</deptLists>\\n <email>[email protected]</email>\\n <hiredDate>1631845101798</hiredDate>\\n <identities>\\n <externUid>1236666</externUid>\\n <provider>Dingtalk</provider>\\n </identities>\\n <joinTime>1631845101798</joinTime>\\n <lastVisitTime>1631845101798</lastVisitTime>\\n <mobile>1390000****</mobile>\\n <organizationMemberName>名字1</organizationMemberName>\\n <organizationRoleName>管理员</organizationRoleName>\\n <organizationRoleId>8fc0c9ff039711dd64acd000</organizationRoleId>\\n <state>normal</state>\\n </member>\\n <errorCode>null</errorCode>\\n <success>true</success>\\n</GetOrganizationMemberResponse>","errorExample":""}]', + 'title' => '查询企业成员信息', + ], + 'ListJoinedOrganizations' => [ + 'summary' => '查询当前账号加入的企业列表。', + 'path' => '/users/joinedOrgs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ApiGenericResult<List<OrganizationVO>>', + 'description' => 'ApiGenericResult<List<OrganizationVO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '11D0EE6E-5803-5D4C-A652-E672BE1F3D8F', + ], + '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' => '企业ID', + 'type' => 'string', + 'example' => '65f25d0fa54c216dcf6b1dbd', + ], + 'name' => [ + 'description' => '企业名称', + 'type' => 'string', + 'example' => '云效测试企业', + ], + 'isOrgAdmin' => [ + 'description' => '是否企业管理员', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询加入的企业列表', + ], + 'GetApplication' => [ + 'summary' => '查询应用详情。', + 'path' => '/appstack/apps/{appName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '已按名称查找到应用详情', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'example' => 'testApp', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00.000+00:00', + ], + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '创建者阿里云UID', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'description' => [ + 'title' => '应用描述', + 'description' => '应用描述', + 'type' => 'string', + 'example' => '应用描述', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'appTemplateName' => [ + 'title' => '应用模版名称', + 'description' => '应用模版名称', + 'type' => 'string', + 'example' => '应用模版名称A', + ], + 'appTemplateDisplayName' => [ + 'title' => '应用模版展示名称', + 'description' => '应用模版展示名称', + 'type' => 'string', + 'example' => '应用模版展示名称A', + ], + ], + ], + ], + 404 => [ + 'description' => '未查找到应用详情', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"description\\": \\"应用描述\\",\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"appTemplateName\\": \\"应用模版名称A\\",\\n \\"appTemplateDisplayName\\": \\"应用模版展示名称A\\"\\n}","type":"json"}]', + 'title' => '查询应用详情', + ], + 'UpdateApplication' => [ + 'summary' => '更新应用的拥有者。', + 'path' => '/appstack/apps/{appName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求的结构体', + 'type' => 'object', + 'properties' => [ + 'ownerAccountId' => [ + 'title' => '拥有者阿里云UID', + 'description' => '拥有者阿里云UID', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1332695887xxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '更新成功', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '创建者阿里云UID', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + 'name' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'example' => 'testApp', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00.000+00:00', + ], + 'description' => [ + 'title' => '应用描述', + 'description' => '应用描述', + 'type' => 'string', + 'example' => '应用描述', + ], + ], + ], + ], + 404 => [ + 'description' => '未查找到指定的应用', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\",\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"description\\": \\"应用描述\\"\\n}","type":"json"}]', + 'title' => '更新应用', + ], + 'ListApplications' => [ + 'summary' => '查询应用列表信息。', + 'path' => '/appstack/apps:search', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'title' => '分页模式参数，目前只支持键集分页 keyset 模式', + 'description' => '分页模式参数，目前只支持键集分页 keyset 模式', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'keyset', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页尺寸参数，决定一页最多返回多少对象', + 'description' => '分页尺寸参数，决定一页最多返回多少对象', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'description' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'id', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'asc', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'description' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'type' => 'string', + 'required' => false, + 'example' => 'vxc2341gfssad12', + ], + ], + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '分页查找完成（包括未查找到对象的情况）', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '键集分页 token', + 'description' => '键集分页 token', + 'type' => 'string', + 'example' => 'vxc2341gfssad12', + ], + 'data' => [ + 'description' => '应用结果列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'title' => '创建者阿里云UID', + 'description' => '创建者阿里云UID', + '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' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"vxc2341gfssad12\\",\\n \\"data\\": [\\n {\\n \\"creatorAccountId\\": \\"1332695887xxxxxx\\",\\n \\"name\\": \\"testApp\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00.000+00:00\\",\\n \\"description\\": \\"应用描述\\"\\n }\\n ],\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"\\n}","type":"json"}]', + 'title' => '查询应用列表', + ], + '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' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '分页查找完成（包括未查找到对象的情况）', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'total' => [ + 'title' => '列表总数', + 'description' => '列表总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'current' => [ + 'title' => '当前所在分页', + 'description' => '当前所在分页', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页规模', + 'description' => '分页规模', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'pages' => [ + 'title' => '总页数', + 'description' => '总页数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'records' => [ + 'title' => '成员列表', + 'description' => '成员列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '成员id，类型为User时为成员的阿里云UID', + 'type' => 'string', + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '成员类型，目前只支持User', + 'type' => 'string', + 'example' => 'User', + ], + 'displayName' => [ + 'title' => '成员显示名', + 'description' => '成员显示名', + 'type' => 'string', + 'example' => '成员1', + ], + 'description' => [ + 'title' => '成员描述', + 'description' => '成员描述', + 'type' => 'string', + 'example' => '成语描述', + ], + 'avatar' => [ + 'title' => '头像', + 'description' => '头像', + 'type' => 'string', + 'example' => 'http://', + ], + 'roleList' => [ + 'title' => '成员的角色列表', + 'description' => '成员的角色列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '角色名', + 'description' => '角色名', + 'type' => 'string', + 'example' => 'developer', + ], + 'displayName' => [ + 'title' => '角色显示名', + 'description' => '角色显示名', + 'type' => 'string', + 'example' => '开发者', + ], + ], + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 100,\\n \\"current\\": 1,\\n \\"pageSize\\": 10,\\n \\"pages\\": 10,\\n \\"records\\": [\\n {\\n \\"id\\": \\"1332695887xxxxxx\\",\\n \\"type\\": \\"User\\",\\n \\"displayName\\": \\"成员1\\",\\n \\"description\\": \\"成语描述\\",\\n \\"avatar\\": \\"http://\\",\\n \\"roleList\\": [\\n {\\n \\"name\\": \\"developer\\",\\n \\"displayName\\": \\"开发者\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"\\n}","type":"json"}]', + 'title' => '查询应用成员列表', + ], + 'CreateAppMembers' => [ + 'summary' => '创建应用成员。', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体', + 'type' => 'object', + 'properties' => [ + 'roleNames' => [ + 'title' => '添加成员的角色列表', + 'description' => '添加成员的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '角色名', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'owner' => '拥有者', + 'tester' => '测试', + 'admin' => '负责人', + 'developer' => '开发', + 'operator' => '运维', + ], + 'example' => 'developer', + ], + 'required' => false, + 'docRequired' => true, + ], + 'playerList' => [ + 'title' => '添加的成员列表', + 'description' => '添加的成员列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '成员id，类型为User时为成员的阿里云UID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '成员类型，目前只支持User', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + 'default' => 'User', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '添加应用成员成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 403 => [ + 'description' => '没权限设置拥有者', + ], + [ + 'description' => '角色未找到', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => '创建应用成员', + ], + 'UpdateAppMember' => [ + 'summary' => '更新应用成员。', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体', + 'type' => 'object', + 'properties' => [ + 'roleNames' => [ + 'title' => '更新成员的角色列表', + 'description' => '更新成员的角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '角色名', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'owner' => '拥有者', + 'tester' => '测试', + 'admin' => '负责人', + 'developer' => '开发', + 'operator' => '运维', + ], + 'example' => 'developer', + ], + 'required' => false, + ], + 'player' => [ + 'title' => '更新的成员', + 'description' => '更新的成员', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '成员id，类型为User时为成员的阿里云UID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + 'type' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '成员类型，目前只支持User', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + 'default' => 'User', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '更新应用成员角色成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 404 => [ + 'description' => '应用角色未找到', + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => '更新应用成员', + ], + 'DeleteAppMember' => [ + 'summary' => '删除应用成员。', + 'path' => '/appstack/apps/{appName}/members', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + '应用', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'subjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '成员类型，目前只支持User', + 'description' => '成员类型，目前只支持User', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'User', + ], + ], + [ + 'name' => 'subjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '成员id，类型为User时为成员的阿里云UID', + 'description' => '成员id，类型为User时为成员的阿里云UID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1332695887xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '删除应用成员成功', + 'schema' => [ + 'title' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', + 'type' => 'string', + 'example' => 'FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F', + ], + ], + 500 => [ + 'description' => '服务端内部异常', + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F\\"","type":"json"}]', + 'title' => '删除应用成员', + ], + 'GetReleaseStagePipelineRun' => [ + 'summary' => '可以获取研发阶段流水线运行实例相关信息。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:getPipelineRun', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段的执行记录编号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetPipelineRunResponse', + 'description' => 'GetPipelineRunResponse', + 'type' => 'object', + 'properties' => [ + 'pipelineRun' => [ + 'description' => '流水线运行实例', + 'type' => 'object', + 'properties' => [ + 'creatorAccountId' => [ + 'description' => '创建者阿里云账号id', + 'type' => 'string', + 'example' => '1111111111', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'updateTime' => [ + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'modifierAccountId' => [ + 'description' => '更新人阿里云账号id', + 'type' => 'string', + 'example' => '11111111111', + ], + 'pipelineId' => [ + 'description' => '流水线Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'pipelineRunId' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'status' => [ + 'description' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'triggerMode' => [ + 'description' => '- 触发模式'."\n" + .' '."\n" + .' 1人工触发'."\n" + .' '."\n" + .' 2定时触发 '."\n" + ."\n" + .' 3代码提交触发'."\n" + .' '."\n" + .' 5流水线触发'."\n" + ."\n" + .' 6WEBHOOK触发', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'stageGroup' => [ + 'description' => '阶段拓扑信息', + 'type' => 'array', + 'items' => [ + 'description' => 'Group', + 'type' => 'array', + 'items' => [ + 'description' => '阶段', + 'type' => 'string', + 'example' => '阶段名称', + ], + ], + ], + 'stages' => [ + 'description' => '阶段信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '阶段名称', + 'type' => 'string', + 'example' => 'Java构建', + ], + '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' => 'Java构建', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'jobs' => [ + 'description' => '任务', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21212', + ], + 'name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'Java构建', + ], + 'startTime' => [ + 'description' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'endTime' => [ + 'description' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586863220000', + ], + 'status' => [ + 'description' => '状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'params' => [ + 'description' => '触发参数', + 'type' => 'string', + 'example' => '{}', + ], + 'actions' => [ + 'description' => '后续操作,具体参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'string', + 'example' => 'PassPipelineValidate', + ], + 'disable' => [ + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'boolean', + 'example' => 'true', + ], + 'params' => [ + 'description' => '参考文档https://help.aliyun.com/document_detail/2360596.html', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'sources' => [ + 'description' => '代码源', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '代码库类型 Codeup codeup 代码源 aliyunGit 阿里云code giteeGit 码云', + 'type' => 'string', + 'example' => 'Codeup', + ], + 'sign' => [ + 'description' => '代码源唯一标识', + 'type' => 'string', + 'example' => 'assaaaaaasasasa', + ], + 'data' => [ + 'description' => '代码源信息', + 'type' => 'object', + 'properties' => [ + 'branch' => [ + 'description' => '代码分支', + 'type' => 'string', + 'example' => 'master', + ], + 'commit' => [ + 'description' => '提交信息 JSON 数据', + 'type' => 'string', + 'example' => '{}', + ], + 'repo' => [ + 'description' => '代码库地址', + 'type' => 'string', + 'example' => 'http://codeup.aliyun.com/a.git', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pipelineRun\\": {\\n \\"creatorAccountId\\": \\"1111111111\\",\\n \\"createTime\\": 1586863220000,\\n \\"updateTime\\": 1586863220000,\\n \\"modifierAccountId\\": \\"11111111111\\",\\n \\"pipelineId\\": 1234,\\n \\"pipelineRunId\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"triggerMode\\": 1,\\n \\"stageGroup\\": [\\n [\\n \\"阶段名称\\"\\n ]\\n ],\\n \\"stages\\": [\\n {\\n \\"name\\": \\"Java构建\\",\\n \\"stageInfo\\": {\\n \\"startTime\\": 1586863220000,\\n \\"endTime\\": 1586863220000,\\n \\"name\\": \\"Java构建\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"jobs\\": [\\n {\\n \\"id\\": 21212,\\n \\"name\\": \\"Java构建\\",\\n \\"startTime\\": 1586863220000,\\n \\"endTime\\": 1586863220000,\\n \\"status\\": \\"RUNNING\\",\\n \\"params\\": \\"{}\\",\\n \\"actions\\": [\\n {\\n \\"type\\": \\"PassPipelineValidate\\",\\n \\"disable\\": true,\\n \\"params\\": \\"{}\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"sources\\": [\\n {\\n \\"type\\": \\"Codeup\\",\\n \\"sign\\": \\"assaaaaaasasasa\\",\\n \\"data\\": {\\n \\"branch\\": \\"master\\",\\n \\"commit\\": \\"{}\\",\\n \\"repo\\": \\"http://codeup.aliyun.com/a.git\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取研发阶段流水线运行实例', + ], + 'ExecuteChangeRequestReleaseStage' => [ + 'summary' => '可以执行研发阶段流水线。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}:execute', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'params' => [ + 'description' => '参数', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '流水线源: 分支名\\'."\n" + .'FLOW_INST_RUNNING_COMMENT: 运行备注', + 'example' => '"spring-boot": "master",'."\n" + .'"FLOW_INST_RUNNING_COMMENT": "运行备注"', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ExecutePipelineResult', + 'description' => 'ExecutePipelineResult', + 'type' => 'object', + 'properties' => [ + 'object' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pipelineId' => [ + 'description' => '流水线id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3259***', + ], + 'pipelineRunId' => [ + 'description' => '流水线运行实例id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"object\\": 1,\\n \\"pipelineId\\": 0,\\n \\"pipelineRunId\\": 1\\n}","type":"json"}]', + 'title' => '执行研发阶段流水线', + ], + 'CancelExecutionReleaseStage' => [ + 'summary' => '可以取消执行研发阶段流水线。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c19****', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'app-name', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段的执行记录编号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CancelExecutionResponse', + 'description' => 'CancelExecutionResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '取消执行研发阶段流水线', + ], + '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' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'List<ReleaseWorkflow>', + 'description' => 'List<ReleaseWorkflow>', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'example' => 'testApp', + ], + 'sn' => [ + 'title' => '唯一标识sn', + 'description' => '研发流程唯一标识', + 'type' => 'string', + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => '标准研发流程', + ], + 'order' => [ + 'title' => '排序', + 'description' => '排序', + 'type' => 'string', + 'example' => '1', + ], + 'releaseStages' => [ + 'title' => '研发阶段', + 'description' => '研发阶段', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appName' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'example' => 'testApp', + ], + 'name' => [ + 'title' => '阶段名', + 'description' => '阶段名', + 'type' => 'string', + 'example' => '开发阶段', + ], + 'sn' => [ + 'title' => '阶段sn', + 'description' => '研发阶段唯一标识', + 'type' => 'string', + 'example' => '5aa8cc67e75e41bf9dddeb708775bcc3', + ], + 'releaseWorkflowSn' => [ + 'title' => '所属的研发流程sn', + 'description' => '所属的研发流程sn', + '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' => '变量组类型：GLOBAL - 全局变量组；APP - 应用变量组；', + 'type' => 'string', + 'example' => 'APP', + 'enum' => [ + 'GLOBAL', + 'APP', + ], + ], + ], + ], + ], + ], + ], + ], + 'note' => [ + 'title' => '公告', + 'description' => '公告', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"appName\\": \\"testApp\\",\\n \\"sn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"name\\": \\"标准研发流程\\",\\n \\"order\\": \\"1\\",\\n \\"releaseStages\\": [\\n {\\n \\"appName\\": \\"testApp\\",\\n \\"name\\": \\"开发阶段\\",\\n \\"sn\\": \\"5aa8cc67e75e41bf9dddeb708775bcc3\\",\\n \\"releaseWorkflowSn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"order\\": \\"1\\",\\n \\"variableGroups\\": [\\n {\\n \\"name\\": \\"dev\\",\\n \\"displayName\\": \\"开发环境变量组\\",\\n \\"type\\": \\"APP\\"\\n }\\n ]\\n }\\n ],\\n \\"note\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n]","type":"json"}]', + 'title' => '查找应用下所有的研发流程', + ], + 'ListAppReleaseStageExecutions' => [ + 'summary' => '批量查询研发阶段执行记录。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + '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' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => '340beb481a334fd49b006816382f0c11', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段sn', + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + [ + 'name' => 'pagination', + 'in' => 'query', + 'schema' => [ + 'description' => '分页模式参数：keyset表示键集分页', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'keyset' => 'keyset', + ], + 'example' => 'keyset', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页尺寸参数，决定一页最多返回多少对象，默认20，限制[1,100]', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分页排序属性，决定根据何种属性进行记录排序；默认 gmtCreate', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + 'gmtCreate' => 'gmtCreate', + ], + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '分页排序升降序，asc 为升序，desc 为降序；默认 desc', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'description' => '键集分页模式下不需要传入', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageList<ReleaseStageInstanceVO>', + 'description' => 'PageList<ReleaseStageInstanceVO>', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'description' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'type' => 'string', + 'example' => 'vxc2341gfssad12', + ], + 'data' => [ + 'title' => '分页结果数据', + 'description' => '分页结果数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'number' => [ + 'title' => '流水线执行编号', + 'description' => '流水线执行编号', + 'type' => 'string', + 'example' => '1', + ], + 'state' => [ + 'title' => '流水线执行状态', + 'description' => '流水线执行状态', + 'type' => 'string', + 'example' => 'SUCCESS', + 'enum' => [ + 'RUNNING', + 'SUCCESS', + 'FAILED', + 'CANCELED', + 'UNKNOWN', + ], + ], + 'triggerMode' => [ + 'title' => '流水线执行触发方式', + 'description' => '流水线执行触发方式', + 'type' => 'string', + 'example' => 'MANUAL', + ], + 'startTime' => [ + 'title' => '流水线执行开始时间', + 'description' => '流水线执行开始时间', + 'type' => 'string', + 'example' => '2024-06-25T07:25:54.000+00:00', + ], + 'endTime' => [ + 'title' => '流水线执行结束时间', + 'description' => '流水线执行结束时间', + 'type' => 'string', + 'example' => '2024-06-25T07:26:18.000+00:00', + ], + ], + ], + ], + 'total' => [ + 'title' => '页码分页时存在该字段，表示结果总数', + 'description' => '页码分页时存在该字段，表示结果总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'current' => [ + 'title' => '页码分页时存在该字段，表示当前页', + 'description' => '页码分页时存在该字段，表示当前页', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'perPage' => [ + 'title' => '页码分页时存在该字段，表示每页大小', + 'description' => '页码分页时存在该字段，表示每页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'title' => '页码分页时存在该字段，表示总页数', + 'description' => '页码分页时存在该字段，表示总页数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"vxc2341gfssad12\\",\\n \\"data\\": [\\n {\\n \\"number\\": \\"1\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"triggerMode\\": \\"MANUAL\\",\\n \\"startTime\\": \\"2024-06-25T07:25:54.000+00:00\\",\\n \\"endTime\\": \\"2024-06-25T07:26:18.000+00:00\\"\\n }\\n ],\\n \\"total\\": 2,\\n \\"current\\": 1,\\n \\"perPage\\": 20,\\n \\"pages\\": 1\\n}","type":"json"}]', + 'title' => '批量查询研发阶段执行记录', + ], + 'ListAppReleaseStageExecutionIntegratedMetadata' => [ + 'summary' => '查询研发阶段执行记录集成变更信息。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}/integratedMetadata', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + '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' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段sn', + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'title' => '研发阶段的执行记录编号', + 'description' => '研发阶段的执行记录编号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'List<ReleaseStageInstanceIntegratedMetadataVO>', + 'description' => 'List<ReleaseStageInstanceIntegratedMetadataVO>', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'releaseBranch' => [ + 'title' => '发布分支', + 'description' => '发布分支', + 'type' => 'string', + 'example' => 'release/20240625-152603220321211_release_3252057_1', + ], + 'releaseRevision' => [ + 'title' => '发布分支git版本', + 'description' => '发布分支git版本', + 'type' => 'string', + 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7', + ], + 'repoUrl' => [ + 'title' => '代码仓库地址', + 'description' => '代码仓库地址', + 'type' => 'string', + 'example' => 'https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/auto-test.git', + ], + 'repoType' => [ + 'title' => '代码仓库类型', + 'description' => '库类型', + 'type' => 'string', + 'example' => 'CODEUP', + ], + 'changeRequests' => [ + 'title' => '变更请求', + 'description' => '变更请求', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sn' => [ + 'title' => '变更请求编号', + 'description' => '变更请求唯一标识', + 'type' => 'string', + 'example' => 'fcd37726a6f84c60b7eb9c5856007c2f', + ], + 'name' => [ + 'title' => '变更请求名称', + 'description' => '变更请求名称', + 'type' => 'string', + 'example' => '变更名称', + ], + 'branchName' => [ + 'title' => '变更请求分支', + 'description' => '变更请求分支', + 'type' => 'string', + 'example' => 'feature/20240625', + ], + 'commitId' => [ + 'title' => '变更请求commitId', + 'description' => '变更请求commitId', + 'type' => 'string', + 'example' => 'a66cfa8c6869b96bb7d111ba2144c9c764d556b7', + ], + 'ownerAccountId' => [ + 'title' => '变更请求拥有者的阿里云pk', + 'description' => '变更请求拥有者的阿里云pk', + 'type' => 'string', + 'example' => '262579140573491041', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"releaseBranch\\": \\"release/20240625-152603220321211_release_3252057_1\\",\\n \\"releaseRevision\\": \\"a66cfa8c6869b96bb7d111ba2144c9c764d556b7\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/60d54f3daccf2bbd6659f3ad/auto-test.git\\",\\n \\"repoType\\": \\"CODEUP\\",\\n \\"changeRequests\\": [\\n {\\n \\"sn\\": \\"fcd37726a6f84c60b7eb9c5856007c2f\\",\\n \\"name\\": \\"变更名称\\",\\n \\"branchName\\": \\"feature/20240625\\",\\n \\"commitId\\": \\"a66cfa8c6869b96bb7d111ba2144c9c764d556b7\\",\\n \\"ownerAccountId\\": \\"262579140573491041\\"\\n }\\n ]\\n }\\n]","type":"json"}]', + 'title' => '查询研发阶段执行记录集成变更信息', + ], + 'RefuseReleaseStagePipelineValidate' => [ + 'summary' => '可以拒绝研发阶段流水线中的人工卡点。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:refusePipelineValidate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c19****', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段的执行记录编号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务Id，可通过API https://help.aliyun.com/document_detail/2839080.html 获取任务Id', + 'type' => 'string', + 'required' => true, + 'example' => '226241***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RefusePipelineValidateResponse', + 'description' => 'RefusePipelineValidateResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '拒绝研发阶段流水线人工卡点', + ], + 'PassReleaseStagePipelineValidate' => [ + 'summary' => '可以通过研发阶段流水线中的人工卡点。', + 'path' => '/appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:passPipelineValidate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199***', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发流程sn', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf8747368383****', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段sn', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c922****', + ], + ], + [ + 'name' => 'executionNumber', + 'in' => 'path', + 'schema' => [ + 'description' => '研发阶段的执行记录编号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务Id，可通过API https://help.aliyun.com/document_detail/2839080.html 获取任务Id', + 'type' => 'string', + 'required' => true, + 'example' => '226241***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PassPipelineValidateResponse', + 'description' => 'PassPipelineValidateResponse', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'description' => '调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '通过研发阶段流水线人工卡点', + ], + 'CreateChangeRequest' => [ + 'summary' => '创建应用变更。', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'app-name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'required' => true, + 'example' => '变更标题', + ], + 'ownerId' => [ + 'title' => 'ownerId', + 'type' => 'string', + 'required' => true, + ], + 'ownerAccountId' => [ + 'description' => '拥有者阿里云UID', + 'type' => 'string', + 'required' => false, + 'example' => '1332695887xxxxxx', + ], + 'appCodeRepoSn' => [ + 'title' => '应用代码库唯一标识', + 'description' => '应用代码库唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'sn123', + ], + 'branchName' => [ + 'title' => '分支名称', + 'description' => '分支名称', + 'type' => 'string', + 'required' => true, + 'example' => 'hotfix/20240524', + ], + 'autoDeleteBranchWhenEnd' => [ + 'title' => '变更结束后是否自动删除分支', + 'description' => '变更结束后是否自动删除分支', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'createBranch' => [ + 'title' => '是否创建新分支', + 'description' => '是否创建新分支', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ChangeRequestVO', + 'description' => 'ChangeRequestVO', + 'type' => 'object', + 'properties' => [ + 'sn' => [ + 'title' => '唯一标识符', + 'description' => '唯一标识符', + 'type' => 'string', + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + 'appName' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'example' => 'app-name', + ], + 'state' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'DEVELOPING', + ], + 'name' => [ + 'title' => '变更名称', + 'description' => '变更名称', + 'type' => 'string', + 'example' => '变更名称', + ], + 'type' => [ + 'title' => '变更状态', + 'description' => '变更状态', + 'type' => 'string', + 'example' => 'APP', + ], + 'appCodeRepoSn' => [ + 'title' => '代码仓库唯一标识', + 'description' => '代码仓库唯一标识', + 'type' => 'string', + 'example' => 'sn123', + ], + 'branch' => [ + 'title' => '变更代码分支', + 'description' => '变更代码分支', + 'type' => 'string', + 'example' => 'hotfix/20240524', + ], + 'ownerId' => [ + 'title' => '拥有者云效id', + 'description' => '拥有者云效id', + 'type' => 'string', + 'example' => 'owner-id-123', + ], + 'ownerAccountId' => [ + 'title' => '拥有者的阿里云账号pk', + 'description' => '拥有者的阿里云账号pk', + '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' => '创建者者云效id', + 'type' => 'string', + 'example' => 'create-id-123'."\n", + ], + 'creatorAccountId' => [ + 'title' => '创建者的阿里云账号pk', + 'description' => '创建者的阿里云账号pk', + 'type' => 'string', + 'example' => 'create-account-123', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'gmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'autoDeleteBranchWhenEnd' => [ + 'title' => '结束后是否自动删除分支', + 'description' => '结束后是否自动删除分支', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sn\\": \\"ce51b31b996246ecaf874736838360b2\\",\\n \\"appName\\": \\"app-name\\",\\n \\"state\\": \\"DEVELOPING\\",\\n \\"name\\": \\"变更名称\\",\\n \\"type\\": \\"APP\\",\\n \\"appCodeRepoSn\\": \\"sn123\\",\\n \\"branch\\": \\"hotfix/20240524\\",\\n \\"ownerId\\": \\"owner-id-123\\",\\n \\"ownerAccountId\\": \\"account-id-123\\",\\n \\"originBranch\\": \\"master\\",\\n \\"originBranchRevisionSha\\": \\"revision-123\\",\\n \\"creatorId\\": \\"create-id-123\\\\n\\",\\n \\"creatorAccountId\\": \\"create-account-123\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\",\\n \\"autoDeleteBranchWhenEnd\\": false\\n}","type":"json"}]', + 'title' => '创建应用变更', + ], + 'ListChangeRequests' => [ + 'summary' => '查询变更列表。', + 'path' => '/appstack/apps/{appName}/changeRequests', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + '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' => '分页模式参数，目前只支持键集分页 keyset 模式', + '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' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + ], + 'example' => 'id', + 'default' => 'desc', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + 'description' => '键集分页 token，获取第一页数据时无需传入，否则需要传入前一页查询结果中的 nextToken 字段', + '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' => '按ownerId进行搜索', + 'type' => 'array', + 'items' => [ + 'description' => '拥有者id', + 'type' => 'string', + 'required' => false, + 'example' => 'eycodj8dshsmf6ss65s', + ], + 'required' => false, + ], + ], + [ + 'name' => 'appNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按应用名称进行搜索', + 'description' => '按应用名称进行搜索', + 'type' => 'array', + 'items' => [ + 'description' => '应用名', + 'type' => 'string', + 'required' => false, + 'example' => 'app-name', + ], + 'required' => false, + ], + ], + [ + 'name' => 'displayNameKeyword', + 'in' => 'query', + 'schema' => [ + 'title' => '按展示名进行模糊搜索的关键字', + 'description' => '按展示名进行模糊搜索的关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'change1', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页面分页时使用，用于获取下一页内容', + 'description' => '页面分页时使用，用于获取下一页内容', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageList<ChangeRequestVO>', + 'description' => 'PageList<ChangeRequestVO>', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'description' => '采用键值分页时存在该字段，用于传给分页接口，迭代获取下一页数据', + 'type' => 'string', + 'example' => 'eb13ac6049d3d78159d60f84af', + ], + 'data' => [ + 'title' => '分页结果数据', + 'description' => '分页结果数据', + 'type' => 'array', + 'items' => [ + 'description' => '变更信息', + 'type' => 'any', + 'example' => '{"sn":"sn_bbe378996538","appName":"app-name","state":"RELEASED","name":"name_7699a487e82c","type":"APP","appCodeRepoSn":"appCodeRepoSn_f46c1f3f2d3e","branch":"branch_8b3bcdcb8086","ownerId":"ownerId_2ec0c96eb7e2","ownerAccountId":"ownerAccountId_93a92d951cfe","originBranch":"master","originBranchRevisionSha":"originBranchRevisionSha_8fc026946097","creatorId":"creatorId_53660e01024f","creatorAccountId":"creatorAccountId_480afbff2edc","gmtCreate":"2024-07-09 11:19:54","gmtModified":"2024-07-09 11:19:54","autoDeleteBranchWhenEnd":false}', + ], + ], + 'total' => [ + 'title' => '页码分页时存在该字段，表示结果总数', + 'description' => '页码分页时存在该字段，表示结果总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'current' => [ + 'title' => '页码分页时存在该字段，表示当前页', + 'description' => '页码分页时存在该字段，表示当前页', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'perPage' => [ + 'title' => '页码分页时存在该字段，表示每页大小', + 'description' => '页码分页时存在该字段，表示每页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'title' => '页码分页时存在该字段，表示总页数', + 'description' => '页码分页时存在该字段，表示总页数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"eb13ac6049d3d78159d60f84af\\",\\n \\"data\\": [\\n \\"{\\\\\\"sn\\\\\\":\\\\\\"sn_bbe378996538\\\\\\",\\\\\\"appName\\\\\\":\\\\\\"app-name\\\\\\",\\\\\\"state\\\\\\":\\\\\\"RELEASED\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name_7699a487e82c\\\\\\",\\\\\\"type\\\\\\":\\\\\\"APP\\\\\\",\\\\\\"appCodeRepoSn\\\\\\":\\\\\\"appCodeRepoSn_f46c1f3f2d3e\\\\\\",\\\\\\"branch\\\\\\":\\\\\\"branch_8b3bcdcb8086\\\\\\",\\\\\\"ownerId\\\\\\":\\\\\\"ownerId_2ec0c96eb7e2\\\\\\",\\\\\\"ownerAccountId\\\\\\":\\\\\\"ownerAccountId_93a92d951cfe\\\\\\",\\\\\\"originBranch\\\\\\":\\\\\\"master\\\\\\",\\\\\\"originBranchRevisionSha\\\\\\":\\\\\\"originBranchRevisionSha_8fc026946097\\\\\\",\\\\\\"creatorId\\\\\\":\\\\\\"creatorId_53660e01024f\\\\\\",\\\\\\"creatorAccountId\\\\\\":\\\\\\"creatorAccountId_480afbff2edc\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2024-07-09 11:19:54\\\\\\",\\\\\\"gmtModified\\\\\\":\\\\\\"2024-07-09 11:19:54\\\\\\",\\\\\\"autoDeleteBranchWhenEnd\\\\\\":false}\\"\\n ],\\n \\"total\\": 100,\\n \\"current\\": 1,\\n \\"perPage\\": 20,\\n \\"pages\\": 5\\n}","type":"json"}]', + 'title' => '查询变更列表', + ], + 'ListChangeRequestWorkflowExecutions' => [ + 'summary' => '查询变更研发流程运行记录。', + 'path' => '/appstack/apps/{appName}/changeRequests/{sn}/executions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据面 api 经安全评估统一不做处理，后续逐步安排下线', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'organizationId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业标识，也称企业id', + 'description' => '企业标识，也称企业id', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '66c0c9fffeb86b450c199fcd', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => [ + 'title' => '应用名', + 'description' => '应用名', + 'type' => 'string', + 'required' => true, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'sn', + 'in' => 'path', + 'schema' => [ + 'title' => '变更唯一标识', + 'description' => '变更唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'perPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页尺寸参数，决定一页最多返回多少对象', + 'description' => '分页尺寸参数，决定一页最多返回多少对象', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => [ + 'title' => '页面分页时使用，用于获取下一页内容，默认第1页', + 'description' => '页面分页时使用，用于获取下一页内容，默认第1页', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'orderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'description' => '分页排序属性，决定根据何种属性进行记录排序；推荐在实现严格遍历时，使用 id 属性', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'id' => 'id', + ], + 'example' => 'id', + 'default' => 'id', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'title' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'description' => '分页排序升降序，asc 为升序，desc 为降序；推荐在实现严格遍历时，使用升序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + 'default' => 'desc', + ], + ], + [ + 'name' => 'releaseWorkflowSn', + 'in' => 'query', + 'schema' => [ + 'title' => '研发流程唯一标识', + 'description' => '研发流程唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'ce51b31b996246ecaf874736838360b2', + ], + ], + [ + 'name' => 'releaseStageSn', + 'in' => 'query', + 'schema' => [ + 'title' => '研发流程阶段唯一标识', + 'description' => '研发流程阶段唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'e173f3c11db5445eb426ca33c92207c8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Pagination<ChangeRequestExecutionVO>', + 'description' => 'Pagination<ChangeRequestExecutionVO>', + 'type' => 'object', + 'properties' => [ + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'current' => [ + 'description' => '当前所在分页', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'pages' => [ + 'description' => '总页数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'records' => [ + 'description' => '记录数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '记录详情', + 'type' => 'any', + 'example' => '{"commit":{"id":"9ab34fe4c056"},"state":"RUNNING","runNumber":"123"}', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 200,\\n \\"current\\": 1,\\n \\"pageSize\\": 20,\\n \\"pages\\": 10,\\n \\"records\\": [\\n \\"{\\\\\\"commit\\\\\\":{\\\\\\"id\\\\\\":\\\\\\"9ab34fe4c056\\\\\\"},\\\\\\"state\\\\\\":\\\\\\"RUNNING\\\\\\",\\\\\\"runNumber\\\\\\":\\\\\\"123\\\\\\"}\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询变更研发流程运行记录', + ], + 'ListUserDrawRecordByPk' => [ + 'summary' => '此API用于云效通义灵码运营相关活动使用', + 'path' => '/listUserDrawRecords', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'aliyunPk', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'required' => false, + 'example' => '1789095186553536', + ], + ], + [ + 'name' => 'drawGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'draw任务组', + 'type' => 'string', + 'required' => false, + 'example' => 'task_group_0000', + ], + ], + [ + 'name' => 'drawPoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'draw奖池', + 'type' => 'string', + 'required' => false, + 'example' => 'developer-award-draw-pool_123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据', + 'type' => 'object', + 'properties' => [ + 'uccId' => [ + 'description' => 'uccId信息', + 'type' => 'string', + 'example' => 'dsadsadasd', + ], + 'drawGroup' => [ + 'description' => '任务组', + 'type' => 'string', + 'example' => 'dsadsadsadas', + ], + 'drawPoolName' => [ + 'description' => '奖池信息', + 'type' => 'string', + 'example' => 'dasdsadasdas', + ], + 'taskGroupId' => [ + 'description' => '任务组ID', + 'type' => 'string', + 'example' => 'null', + ], + 'aliyunPk' => [ + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => '1401072305438324', + ], + 'gmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1545726028000', + ], + 'drawResult' => [ + 'description' => '（抽）奖品结果', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ASSDS-ASSASX-XSAXSA-XSAXSAXS', + ], + 'success' => [ + 'description' => 'true 接口调用成功，false 接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'None', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"uccId\\": \\"dsadsadasd\\",\\n \\"drawGroup\\": \\"dsadsadsadas\\",\\n \\"drawPoolName\\": \\"dasdsadasdas\\",\\n \\"taskGroupId\\": \\"null\\",\\n \\"aliyunPk\\": \\"1401072305438324\\",\\n \\"gmtCreate\\": \\"1545726028000\\",\\n \\"drawResult\\": \\"2\\"\\n }\\n ],\\n \\"requestId\\": \\"ASSDS-ASSASX-XSAXSA-XSAXSAXS\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"None\\"\\n}","type":"json"}]', + 'title' => '查询抽奖结果', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'devops.cn-hangzhou.aliyuncs.com', + ], + ], +]; |