diff --git a/README.en.md b/README.en.md index 8cecd80ddd7356b9d7f2c3906babe77e8dc42918..588e197878306c3f4f5303dd58ca70bcaa41ba7a 100644 --- a/README.en.md +++ b/README.en.md @@ -10,7 +10,6 @@ Software architecture description 1. xxxx 2. xxxx -3. xxxx #### Instructions @@ -26,7 +25,7 @@ Software architecture description 4. Create Pull Request -#### Gitee Feature +#### Gitee 1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md 2. Gitee blog [blog.gitee.com](https://blog.gitee.com) diff --git a/README.md b/README.md index 527d1b1e0c536d11d8f0fec8e36a12b36ecfb42b..eec92b57f1c821662524d4b36a0c0cda6a2cd62b 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,12 @@ 文档为.md,img为图片文件夹 -#### 安装教程 +#### 安装教程说明 1. xxxx 2. xxxx -3. xxxx -#### 使用说明 +#### 使用说明书 1. xxxx 2. xxxx @@ -28,7 +27,7 @@ 4. 新建 Pull Request -#### 码云特技 +#### 码云 1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md 2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) @@ -36,3 +35,4 @@ 4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目 5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) 6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +6. 码云封面人物 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/docs/Datastat-API/api.md b/docs/Datastat-API/api.md index 6c27eb81ddf00058325cf4dbf91b080658673692..1f70defa61af6c8f1f4c3a426b89cb482b021c39 100644 --- a/docs/Datastat-API/api.md +++ b/docs/Datastat-API/api.md @@ -3,12 +3,181 @@ * POST ``` { - "pageUrl": "xxxxxxx", - "score": 7, - "suggest": "xxxxxxx" + "feedbackPageUrl": "https://software-website.osinfra.cn", + "feedbackValue": 5, + "feedbackText": "test" } ``` * response ``` -{"code":200,"data":success,"msg":"success"} +{"code":200,"data":"success","msg":"success","update_at":"2024-03-12T06:37:50Z"} +``` + +## globalnps/issue +* URL: https://dsapi.osinfra.cn/query/globalnps/issue?community=openeuler +* POST +``` +{ + "feedbackPageUrl": "https://software-website.osinfra.cn", + "feedbackValue": 5, + "feedbackText": "test" +} +``` +* response +``` +{"code":200,"data":"success","msg":"success","update_at":"2024-03-12T06:37:50Z"} +``` + +## 文档反馈NPS +* URL: https://dsapi.test.osinfra.cn/query/doc/nps/{community} +* 路劲参数 community, 取值:openueler,openubmc +* POST +* 示例 https://dsapi.test.osinfra.cn/query/doc/nps/openueler +``` +{ + "feedbackPageUrl": "http://docs.openeuler.org", + "efficiency": 3, + "accuracy": 3, + "completeness": 3, + "usability": 3 +} +``` +* response +``` +{"code":200,"data":"success","msg":"success","update_at":"2025-03-17T06:37:50Z"} +``` + +## 软件中心快速反馈 Issue +* URL: https://dsapi.osinfra.cn/query/nps/issue?community=software +* POST +``` +{ + "feedbackPageUrl": "https://easysoftware.test.osinfra.cn/zh/rpm/detail?pkgId=openEuler-20.03-LTS-SP1debuginfoaarch64aalib-debuginfo1.4.0-1.oe1aarch64", + "feedbackValue": 5, + "feedbackText": "测试反馈Issue", + "pkgId": "openEuler-20.03-LTS-SP1debuginfoaarch64aalib-debuginfo1.4.0-1.oe1aarch64", + "name": "aalib-debuginfo", + "version": "1.4.0-1.oe1", + "type": "RPM", + "srcRepo": null, + "maintainer": "gitee_id", + "maintainerEmail": null +} +``` +* response +``` +{"code":200,"data":"success","msg":"success","update_at":"2024-07-24T01:34:34Z"} +``` + +## 软件中心反馈 Issue 数据 +* URL: https://dsapi.osinfra.cn/query/repo/issues?community=openeuler&repo=easy-software +* GET +``` +community: 必选,openeuler +repo: 必选,easy-software +filter: 可选,取值范围:待办的、已取消、已完成、已挂起、已验收、新建;缺省时默认返回全部数据 +sort: 可选,取值范围:asc、desc;缺省时默认desc +page: 可选;缺省时默认值为1 +pageSize": 可选,取值范围:5~100;缺省时默认值为10 +``` +* response +``` +{"msg":"success","code":200,"data":[{"total":2,"data":[{"feedback":"config-manager缺失","issue_customize_state":"待办的","user_login":"fu-xinji","created_at":"2024-07-16T09:28:49+08:00","issue_title":"【RPM】-wget-1.20.3-3.oe1","body":"1. 【网站链接】\r\n> https://easysoftware.test.osinfra.cn/zh/rpm/detail?pkgId=openEuler-20.03-LTS-SP1updateaarch64wget1.20.3-3.oe1aarch64\r\n2. 【反馈评分】\r\n> 5\r\n3. 【反馈意见】\r\n> config-manager缺失","url":"https://gitee.com/openeuler/easy-software/issues/IAD7FU"},{"feedback":"测试-1","issue_customize_state":"待办的","user_login":"baigj","created_at":"2024-07-12T15:14:15+08:00","issue_title":"【RPM】-aalib-debuginfo-1.4.0-1.oe1","body":"1. 【网站链接】\r\n> https://easysoftware.test.osinfra.cn/zh/rpm/detail?pkgId=openEuler-20.03-LTS-SP1debuginfoaarch64aalib-debuginfo1.4.0-1.oe1aarch64\r\n2. 【反馈评分】\r\n> 5\r\n3. 【反馈意见】\r\n> 测试-1","url":"https://gitee.com/openeuler/easy-software/issues/IACJZ0"}]}]} +``` + +## ISV伙伴数 +* URL: https://dsapi.osinfra.cn/query/isv/count?community=openeuler +* 请求方式: POST +* header: +``` +{ + "token": token_value +} +``` +* RequestBody +``` +{ + "count": 1000 +} +``` +* response +``` +{"code":200,"data":null,"msg":"success","update_at":"2024-03-12T06:37:50Z"} +``` + + + +## openMind资源下载 +* URL: https://dsapi.osinfra.cn/query/modelfoundry/download/count +* 请求方式: GET +* 参数: +``` +path:下载环境,取值范围(可缺省:表示生产环境,sh:ascend环境,yidong:移动云环境,tianyi:天翼云环境) +``` + +* response +``` +{"code":200,"data":[{"repo_id":"16","repo":"fff","download":7},{"repo_id":"17","repo":"test","download":3},{"repo_id":"29","repo":"test-npu-003","download":3},{"repo_id":"24","repo":"test0520-002","download":3},{"repo_id":"4","repo":"model_public_gxz","download":2},{"repo_id":"28","repo":"test-npu-002","download":2},{"repo_id":"26","repo":"test_npu","download":2}],"msg":"OK","update_at":"2024-05-21T02:20:05Z"} +``` + + +## openMind资源访问量 +* URL: https://dsapi.test.osinfra.cn/query/modelfoundry/view/count +* 请求方式: GET +* 参数: +``` +path:取值范围(可缺省:表示体验空间,space:体验空间,model:模型,dataset:数据集) +``` + +* response +``` +{"code":200,"data":[{"repo_id":"540","count":7},{"repo_id":"8776","count":5},{"repo_id":"545","count":4},{"repo_id":"6961","count":3},{"repo_id":"539","count":2},{"repo_id":"8775","count":1}],"msg":"OK","update_at":"2024-06-07T06:22:38Z"} +``` + +## 获取仓库的maintainer和committer +* URL: https://dsapi.osinfra.cn/query/sig/repo/committers +* 请求方式: GET +* 参数: +``` +community:必选,取值范围:openeuler +sig:必选,取值范围:sig组名称 +``` + +* response +``` +{ + "msg": "success", + "code": 200, + "data": { + "maintainers": ["xiezhipeng1","licihua"], //sig所有maintainer gitee id + "committers": ["Vchanger","xiezhipeng1","yangyongguang","licihua"], //sig所有committer gitee id + "committerDetails": [ + { + "gitee_id": [ + "Vchanger", + "xiezhipeng1", + "yangyongguang", + ], + "repo": "src-openeuler/EulerCopilot" // 当前repo的所有committer gitee id + }, + { + "gitee_id": [ + "Vchanger", + "licihua", + "xiezhipeng1", + "yangyongguang" + ], + "repo": "openeuler/A-Tune-Collector" // 当前repo的所有committer gitee id + } + ] + }, + "update_at": "2024-06-23T08:24:50Z" +} +``` + +* 示例 +``` +https://dsapi.osinfra.cn/query/sig/repo/committers?community=openeuler&sig=ai + +{"msg":"success","code":200,"data":{"maintainers":["xiezhipeng1","licihua","gaoruoshu","hubin95","yangyongguang","Vchanger"],"committers":["Vchanger","xiezhipeng1","ironictwist","GalaxyG","gameoverboss","a-carter-bear","ksana123","gaoruoshu","znzjugod","Lostwayzxc","sdlzx","licihua","wangning126","yangyongguang","jinyao320","hubin95","eggilu","liu-yuntao-10"],"committerDetails":[{"gitee_id":["Vchanger","gaoruoshu","hubin95","licihua","xiezhipeng1","yangyongguang","znzjugod"],"repo":"src-openeuler/EulerCopilot"},{"gitee_id":["Vchanger","gaoruoshu","hubin95","licihua","xiezhipeng1","yangyongguang"],"repo":"openeuler/A-Tune-Collector"}]},"update_at":"2024-06-23T08:24:50Z"} ``` \ No newline at end of file diff --git a/docs/Datastat-API/meetup_instruction.md b/docs/Datastat-API/meetup_instruction.md index 64e4e4a750b31934d08e1483a0bb700d1717f46a..e045659dbd1f1d6da4c3dc5370261ca29f1bade4 100644 --- a/docs/Datastat-API/meetup_instruction.md +++ b/docs/Datastat-API/meetup_instruction.md @@ -1,5 +1,5 @@ ## 申请表 -* URL: https//:omapi.test.osinfra.cn/add/meetupApplyForm?community=openeuler +* URL: https://dsapi.osinfra.cn/query/meetupApplyForm?community=openeuler * POST ``` { @@ -40,11 +40,12 @@ "comment": "请输入需要的其他支持" } ], - "details": "《openEuler》- 阳" + "details": "《openEuler》- 阳", + "acceptPrivacy": true } ``` -## 场地贡献 -* URL: https//:omapi.test.osinfra.cn/add/meetupVenueInfo?community=openeuler +## 场地贡献(下线) +* URL: https://dsapi.osinfra.cn/query/meetupVenueInfo?community=openeuler * POST ``` { @@ -79,8 +80,8 @@ ] } ``` -## 成绩反馈 -* URL: https//:omapi.test.osinfra.cn/add/meetupTranscript?community=openeuler +## 成绩反馈(下线) +* URL: https://dsapi.osinfra.cn/query/meetupTranscript?community=openeuler * POST ``` { @@ -97,4 +98,29 @@ "significance": "xx企业研发动态", "summary": "经验总结和建议分享xxxxx" } +``` + +## SIG Gathering +* URL: https://dsapi.osinfra.cn/query/sigGathering?community=openeuler +* POST +``` +{ + "name": "name", + "userId": "username", + "company": "company", + "phone": "13800000000", + "email": "test@email.com", + "sigs": [ + "kernel", + "ai" + ], + "technicalSeminars": [ + "专题三:AI原生支持", + "专题一:多样性算力" + ], + "attend": "refuse", + "acceptPrivacyVersion": "agree", + "privacyVersion": "20240530", + "others": "参观" +} ``` \ No newline at end of file diff --git a/docs/Datastat-API/topN_api.md b/docs/Datastat-API/topN_api.md new file mode 100644 index 0000000000000000000000000000000000000000..bfb70ccb5a4f8fa82ae69d9f810ce55f8b529865 --- /dev/null +++ b/docs/Datastat-API/topN_api.md @@ -0,0 +1,81 @@ +## 获取指标数据 +* URL: https://dsapi.osinfra.cn/query/metric/{community} +* Method: GET +* 参数: community,取值openeuler、opengauss、mindspore +* 响应: + +|响应字段|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| external_pr_ratio | 非华为贡献占比 |0.73| - | +| contribute_orgs | 贡献组织数 |3| - | +| issue | 需求/缺陷数 |17773| - | +| issue_reply_time | 需求/缺陷响应时间 |13| - | +| issue_closed_ratio | 需求/缺陷闭环率 |0.83| - | +| users | 开发者数量 |23578|mindspore有,openeuler和opengauss没有此响应字段| + +* 示例:https://dsapi.osinfra.cn/query/metric/mindspore +* response +``` +{ + "code": 200, + "data": { + "external_pr_ratio": 0.73, + "contribute_orgs": 0, + "issue": 43000, + "issue_reply_time": 9, + "issue_closed_ratio": 0.83, + "users": 44874 + }, + "msg": "ok", + "update_at": "2025-02-28T06:33:50Z" +} +``` +## 获取下载量分布 +* URL: https://magicapi.test.osinfra.cn/community/download/source +* Method: GET +* 参数: community,取值openeuler、mindspore +* 响应: + +|响应字段|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| dockerhub | Dockerhub容器镜像 |8097| - | +| obs | MindSpore包whl下载 |6343666| - | +| xihe | 昇思大模型平台下载 |1375203| - | +| gitee_clone | - |58456| - | +| github_clone | - |90293| - | +| tinyms | - |23578| - | +| openmind | openMind/Modelers平台模型下载 |168739| - | +| model_zoo | - |3948030| - | +| pypi | - |501557| - | +| openmind_image | openMind镜像下载 |25| - | +| dockerhub | Dockerhub容器镜像 |77893| - | +| huawei_cloud | 华为云镜像仓库 |1200123| - | +| swr | 官方容器镜像 |87773| - | +| iscas | 软件所 |13667| - | +| qinghua | 清华站 |67883| - | +| oepkgs | OEPKGS开发软件包平台 |23578| - | +| Russia | 俄罗斯 |456| - | +| iso | openEuler官网下载 |235778| - | + +* 示例:https://magicapi.test.osinfra.cn/community/download/source?community=mindspore +* response +``` +{ + "code": 1, + "message": "success", + "data": { + "dockerhub": 8097, + "obs": 6343666, + "xihe": 1375203, + "gitee_clone": 58456, + "tinyms": 15359, + "openmind_image": 25, + "model_zoo": 3948030, + "pypi": 501557, + "openmind": 168739, + "github_clone": 90293 + }, + "timestamp": 1750057493901, + "executeTime": 10 +} +``` \ No newline at end of file diff --git a/docs/Datasta-API/.keep b/docs/EasySoftWare-API/.keep similarity index 100% rename from docs/Datasta-API/.keep rename to docs/EasySoftWare-API/.keep diff --git a/docs/EasySoftWare-API/api.md b/docs/EasySoftWare-API/api.md new file mode 100644 index 0000000000000000000000000000000000000000..f45fbe0d956de55b6bc4f237173090aca18d952a --- /dev/null +++ b/docs/EasySoftWare-API/api.md @@ -0,0 +1,90 @@ +## 获取maintainer维护的软件仓库 +* URL: /collaboration/maintainer/user/repos +* GET +``` +"repo": "grafana", +"kind": "类别", +"status": "状态", +"sigName": "sig名称", +"pageNum": 1, +"pageSize": 10 +``` +* response +``` +{ + "code": 200, + "data": { + "total": 1, + "list": [ + { + "repo": "grafana", + "kind": "类别", + "status": "状态", + "sigName": "sig名称", + "cveStatus": "cve状态", + "issueStatus": "issue状态", + "prStatus": "软件包更新状态", + "contributorStatus": "贡献人员状态", + "orgStatus": "贡献组织状态", + "versionStatus": "软件包版本状态" + } + ] + }, + "msg": "success" +} +``` + +## 管理员获取所有软件仓库 +* URL: /collaboration/admin/user/repos +* GET +``` +"repo": "grafana", +"kind": "类别", +"status": "状态", +"sigName": "sig名称", +"pageNum": 1, +"pageSize": 10 +``` +* response +``` +{ + "code": 200, + "data": { + "total": 1, + "list": [ + { + "repo": "grafana", + "kind": "类别", + "status": "状态", + "sigName": "sig名称", + "cveStatus": "cve状态", + "issueStatus": "issue状态", + "prStatus": "软件包更新状态", + "contributorStatus": "贡献人员状态", + "orgStatus": "贡献组织状态", + "versionStatus": "软件包版本状态" + } + ] + }, + "msg": "success" +} +``` + +## 管理员审批申请单 +* URL: /collaboration/admin/process +* POST +``` +{ + "applyId": 12345, + "applyStatus": "申请单状态--同意(approved)或拒绝(rejected)", + "comment": "审批意见" +} +``` +* response +``` +{ + "code": 200, + "msg": "ok", + +} +``` \ No newline at end of file diff --git a/docs/MagicAPI/api.md b/docs/MagicAPI/api.md new file mode 100644 index 0000000000000000000000000000000000000000..571ad0db2529b59cdaa3cd0344e6ff3ab493cc73 --- /dev/null +++ b/docs/MagicAPI/api.md @@ -0,0 +1,483 @@ +## 指标名称对应 + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| effective_maintenance | 社区有效维护 |-| - | +| version_release | 版本稳定发布 |-| - | +| issue_close | 需求/缺陷闭环率 |-| - | +| contributor_interaction | 贡献者交互率 |-| - | +| first_response | PR/Issue首次响应时间 |-| - | +| contribution_diversity | 贡献企业多样性 |-| - | +| elephant_coefficient | 大象系数 |-| - | +| leverage_ratio | 开发者撬动比 |-| - | +| download | 装机量/下载量 |-| - | +| nss | NSS评分 |-| - | +| certification | 软件供应链安全 |-| - | +| tech_influence | 技术影响力 |-| - | +| effective_maintenance_value | 社区有效维护真实值 |-| - | +| version_release_value | 版本稳定发布真实值 |-| - | +| issue_close_value | 需求/缺陷闭环率真实值 |-| - | +| contributor_interaction_value | 贡献者交互率真实值 |-| - | +| first_response_value | PR/Issue首次响应时间真实值 |-| - | +| contribution_diversity_value | 贡献企业多样性真实值 |-| - | +| elephant_coefficient_value | 大象系数真实值 |-| - | +| leverage_ratio_value | 开发者撬动比真实值 |-| - | +| download_value | 装机量/下载量真实值 |-| - | +| nss_value | NSS评分真实值 |-| - | +| certification_value | 软件供应链安全真实值 |-| - | +| tech_influence_value | 技术影响力真实值 |-| - | + +## (弃用)获取社区健康度指标得分 +* URL: https://magicapi.test.osinfra.cn/health/{community}/score +* Method: GET +* 参数: community,取值openubmc、openeuler、opengauss、mindspore + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +|响应字段|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| xxx | xxx |xxx| - | + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/score +* response +``` +{ + "code": 1, + "message": "success", + "data": [ + { + "created_at": "2025-03-17", + "社区有效维护": 1, + "版本稳定发布": 3, + "需求/缺陷闭环率": 1, + "贡献者交互率": 1, + "PR/Issue首次响应时间": 3, + "贡献企业多样性": 1, + "大象系数": 2, + "开发者撬动比": 5, + "装机量/下载量": 5, + "NSS评分": 5, + "软件供应链安全": 1, + "技术影响力": 2 + } + ], + "timestamp": 1742266743660, + "executeTime": 6 +} +``` + +## (弃用)获取社区健康度指标值 +* URL: https://magicapi.test.osinfra.cn/health/{community}/value +* Method: GET +* 参数: community,取值openubmc、openeuler、opengauss、mindspore + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/value +* response +``` +{ + "code": 1, + "message": "success", + "data": [ + { + "created_at": "2025-03-17", + "社区有效维护": 0.17, + "版本稳定发布": 1.3, + "需求/缺陷闭环率": 0.71, + "贡献者交互率": 1, + "PR/Issue首次响应时间": 3, + "贡献企业多样性": 4, + "大象系数": 2, + "开发者撬动比": 0.8, + "装机量/下载量": 150000, + "NSS评分": 0.5, + "软件供应链安全": 0, + "技术影响力": 0.2 + } + ], + "timestamp": 1742266743660, + "executeTime": 6 +} +``` + +## 获取社区健康度指标趋势 +* URL: https://magicapi.test.osinfra.cn/health/{community}/trend +* Method: GET +* 参数: community,取值openubmc、openeuler、opengauss、mindspore + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/trend +* response +``` +{ + "code": 1, + "message": "success", + "data": { + "date": ["2024-03-07", "2024-03-08", "2025-03-07", "2025-03-08", "2025-03-09", "2025-03-10", "2025-03-11", "2025-03-12", "2025-03-13", "2025-03-14", "2025-03-15", "2025-03-16", "2025-03-17", "2025-03-18"], + "effective_maintenance": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "version_release": [3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3], + "issue_close": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "contributor_interaction": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "first_response": [3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1, 1], + "contribution_diversity": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "elephant_coefficient": [2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2], + "leverage_ratio": [5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5], + "download": [1, 1, 1, 1, 3, 4, 4, 5, 5, 5, 5, 5, 5, 5], + "nss": [5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5], + "certification": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "tech_influence": [2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2], + "effective_maintenance_value": [0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13636364, 0.13333334, 0.13333334], + "version_release_value": [1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2, 1.2], + "issue_close_value": [0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.57421875, 0.57421875], + "contributor_interaction_value": [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0], + "first_response_value": [4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 4.9241433, 7.3131943, 7.3131943], + "contribution_diversity_value": [4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4], + "elephant_coefficient_value": [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], + "leverage_ratio_value": [57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.979465, 57.020233, 57.020233], + "download_value": [10000, 10000, 10000, 20000, 95000, 105000, 107600, 115000, 130000, 140000, 140000, 140000, 140000, 140000], + "nss_value": [0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6, 0.6], + "certification_value": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], + "tech_influence_value": [0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1] + }, + "timestamp": 1742346905138, + "executeTime": 4 +} +``` + +## 获取当前社区健康度指标以及真实值 +* URL: https://magicapi.test.osinfra.cn/health/{community}/metric +* Method: GET +* 参数: community,取值openubmc、openeuler、opengauss、mindspore + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/metric +* response +``` +{ + "code": 1, + "message": "success", + "data": [ + { + "created_at": "2025-03-17", + "effective_maintenance": 1, + "version_release": 3, + "issue_close": 1, + "contributor_interaction": 1, + "first_response": 3, + "contribution_diversity": 1, + "elephant_coefficient": 2, + "leverage_ratio": 5, + "download": 5, + "nss": 5, + "certification": 1, + "tech_influence": 2, + "effective_maintenance_value": 0.13636364, + "version_release_value": 1.2, + "issue_close_value": 0.5, + "contributor_interaction_value": 1.0, + "first_response_value": 4.9241433, + "contribution_diversity_value": 4, + "elephant_coefficient_value": 1, + "leverage_ratio_value": 57.979465, + "download_value": 140000, + "nss_value": 0.6, + "certification_value": 0, + "tech_influence_value": 0.1 + } + ], + "timestamp": 1742278722188, + "executeTime": 5 +} +``` + +## 获取社区健康度指标同比 +* URL: https://magicapi.test.osinfra.cn/health/{community}/on/{interval} +* Method: GET +* 参数: + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | +| interval | 同比间隔 |day, week, year| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/on/year +* response +``` +{ + "code": 1, + "message": "success", + "data": [ + { + "created_at": "2024-03-08", + "effective_maintenance": 1, + "version_release": 3, + "issue_close": 1, + "contributor_interaction": 1, + "first_response": 3, + "contribution_diversity": 1, + "elephant_coefficient": 2, + "leverage_ratio": 5, + "download": 1, + "nss": 5, + "certification": 1, + "tech_influence": 2, + "effective_maintenance_value": 0.13636364, + "version_release_value": 1.2, + "issue_close_value": 0.5, + "contributor_interaction_value": 1.0, + "first_response_value": 4.9241433, + "contribution_diversity_value": 4, + "elephant_coefficient_value": 1, + "leverage_ratio_value": 57.979465, + "download_value": 10000, + "nss_value": 0.6, + "certification_value": 0, + "tech_influence_value": 0.1 + } + ], + "timestamp": 1742279886604, + "executeTime": 7 +} +``` + +## 获取社区有效维护的仓库列表 +* URL: https://magicapi.test.osinfra.cn/health/{community}/active_repo +* Method: GET +* 参数: + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/active_repo +* response +``` +{ + "code": 1, + "message": "success", + "data": { + "repos": ["openUBMC/bingo", "openUBMC/user", "openUBMC/conan-auth-proxy", "openUBMC/infrastructure", "openUBMC/certificate_mgmt", "openUBMC/web_online_help"] + }, + "timestamp": 1742346775735, + "executeTime": 5 +} +``` + +## 获取社区贡献企业列表 +* URL: https://magicapi.test.osinfra.cn/health/{community}/companies +* Method: GET +* 参数: + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 社区名 |openubmc| - | + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/health/openubmc/companies +* response +``` +{ + "code": 1, + "message": "success", + "data": { + "companies": ["华为技术有限公司", "宝德计算机系统股份有限公司", "武汉长江计算科技有限公司"] + }, + "timestamp": 1742348116093, + "executeTime": 12 +} +``` + +## 数据表接口 +* URL: https://magicapi.test.osinfra.cn/customization/{community}/tables +* Method: GET +* 参数: community,开源社区名称 + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| community | 开源社区名称 |openeuler| - | + +* 响应: + +* 示例:https://datastat-develop.test.osinfra.cn/customization/openeuler/tables +* response +``` +{ + "code": 1, + "message": "success", + "data": ["dws_openeuler_contribute", "dws_openeuler_repo_maintain_status", "dws_openeuler_contribute_sig_month", "dws_openeuler_contribute_user_month", "dws_openeuler_contribute_repo_daily", "dws_openeuler_contribute_repo_week", "dws_openeuler_contribute_repo_month"], + "timestamp": 1744073028850, + "executeTime": 5 +} +``` + +## 原始表数据详情接口 +* URL: https://magicapi.test.osinfra.cn/customization/{community}/detail +* Method: POST +* 路径参数: community,开源社区名称 +* body +``` +{ + "dim": [], + "name": "dws_opengauss_contribute", + "filters": [{"column": "user_login", "operator": "=", "value": "zhulixia"}, {"column": "comment_num", "operator": ">", "value": 3}], + "order_field": "html_url", + "order_dir": "asc" +} +``` +* body参数 + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| dim | 数据获取维度 |["user_login","company","contrib_type"]| 获取全部列则为空 | +| name | 表名 |dws_openeuler_contribute| - | +| filters | 过滤条件 |[{"column": "user_login", "operator": "<>", "value": "zhulixia"}]| 支持多个条件组合 | +| order_field | 排序字段 |html_url| - | +| order_dir | 排序规则 |asc| - | + + +* 响应: + +* 示例:https://magicapi.test.osinfra.cn/customization/customization/openeuler/detail +* body +``` +{ + "dim": ["user_login","company","contrib_type"], + "name": "dws_openeuler_contribute", + "filters": [{"column": "user_login", "operator": "=", "value": "openeuler-ci-bot"}, {"column": "contrib_type", "operator": "=", "value": 'comment'}], + "order_field": "user_login", + "order_dir": "asc" +} +``` +* response +``` +{ + "code": 1, + "message": "success", + "data": [{ + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-sync-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-sync-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }, { + "user_login": "openeuler-ci-bot", + "company": "robot", + "contrib_type": "comment" + }], + "timestamp": 1744074259680, + "executeTime": 11 +} +``` + +## 查询总数 +* URL: https://magicapi.test.osinfra.cn/customization/total +* Method: POST +* 路径参数: community,开源社区名称 +* body +``` +{ + "name": "dws_opengauss_contribute", + "filters": [{"column": "user_login", "operator": "=", "value": "zhulixia"}, {"column": "comment_num", "operator": ">", "value": 3}], +} +``` +* body参数 + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| name | 表名 |dws_openeuler_contribute| - | +| filters | 过滤条件 |[{"column": "user_login", "operator": "<>", "value": "zhulixia"}]| 支持多个条件组合 | + +* 示例:https://magicapi.test.osinfra.cn/customization/total +* response +``` +{ + "code": 1, + "message": "success", + "data": { + "count": 65 + }, + "timestamp": 1744110318123, + "executeTime": 166 +} +``` + +## MagicAI接口 +* URL: https://datastat-develop.test.osinfra.cn/model/sql/chat +* Method: POST +* 参数: req,描述用户请求,可转化为sql语句 + +|参数|说明|示例|备注| +| ----------- | ----------| ---- | ---- | +| req | 用户请求 |请给出openeuler合入pr个数| - | + +* 响应: + +* 示例:https://datastat-develop.test.osinfra.cn/model/sql/chat?req=%E8%AF%B7%E7%BB%99%E5%87%BAopeneuler%E5%90%88%E5%85%A5pr%E4%B8%AA%E6%95%B0 +* response +``` +{ + "data": [ + { + "merged_pr_count": 101 + } + ], + "columns": [ + "merged_pr_count" + ], + "sql": "SELECT COUNT(*) AS merged_pr_count FROM fact_contribute_openeuler_pr WHERE state = 'merged';" +} +``` \ No newline at end of file diff --git "a/docs/blueuser/\345\241\224\345\217\260\350\223\235\345\214\272\346\225\260\346\215\256\346\216\245\345\217\243.md" "b/docs/blueuser/\345\241\224\345\217\260\350\223\235\345\214\272\346\225\260\346\215\256\346\216\245\345\217\243.md" index b095303f0547f4692d8005bd6762659a2e7b13e5..8fa53a64b19eac73931483acbb63ed34aa746a2b 100644 --- "a/docs/blueuser/\345\241\224\345\217\260\350\223\235\345\214\272\346\225\260\346\215\256\346\216\245\345\217\243.md" +++ "b/docs/blueuser/\345\241\224\345\217\260\350\223\235\345\214\272\346\225\260\346\215\256\346\216\245\345\217\243.md" @@ -1,7 +1,7 @@ # 人员信息录入 # ## 请求接口 ## ``` -https://omapi.osinfra.cn/query/blueZone/users +https://dsapi.osinfra.cn/query/blueZone/users ``` ## 请求方式 ## @@ -39,7 +39,7 @@ https://omapi.osinfra.cn/query/blueZone/users # 贡献数据查询 # ## 请求接口 ## ``` -https://omapi.osinfra.cn/query/blueZone/contributes +https://dsapi.osinfra.cn/query/blueZone/contributes ``` ## 请求方式 ## @@ -56,7 +56,9 @@ https://omapi.osinfra.cn/query/blueZone/contributes } ``` 说明:时间范围为 startTime 00:00:00 至 endTime 23:59:59,既包含endTime当天的数据 - + +说明:数据量大,建议分批获取用户数据,即gitee_id列表或github_id列表一次性不超过 100 人 + ## 返回结果 ## 说明:一次返回的数据最多1W条,既prs、comments、commit、issue列表数据总条数最多 1W条,若超过1W可以通过时间段多次请求 diff --git a/docs/om-webserver-interface/interface-instruction.md b/docs/om-webserver-interface/interface-instruction.md index 255b0b33cebef2b2b49f4546a9b83163e489a1c8..213230f170daa3fdfc04c5143f4e7933a3f5d713 100644 --- a/docs/om-webserver-interface/interface-instruction.md +++ b/docs/om-webserver-interface/interface-instruction.md @@ -441,11 +441,11 @@ http://192.168.0.1:8888/add/bugquestionnaire { "bugDocFragment": "《离思》 其六 唐.元稹", "existProblem": [ - "示例代码错误", - "内容描述不清楚" + "易用性", + "正确性" ], "comprehensiveSatisfication":7, - "participateReason": "本职工作", + "problemDetail": "test", "email": "TylorSwift@163.com", } ```