Merge pull request #8 from interconn-pec/main

互联互通标准v1.1.0更新
FederatedAI · Dec 24, 2024 · de66ac4 · de66ac4
2 parents 5b0cb3b + e97fa0e
commit de66ac4
Show file tree

Hide file tree

Showing 7 changed files with 397 additions and 343 deletions.
diff --git a/API_SPECS/1.管理层接口/隐私计算互联互通管理层API.md b/API_SPECS/1.管理层接口/隐私计算互联互通管理层API.md
diff --git a/API_SPECS/2.控制层接口/隐私计算互联互通控制层API.md b/API_SPECS/2.控制层接口/隐私计算互联互通控制层API.md
diff --git a/API_SPECS/3.算法组件层接口/README.md b/API_SPECS/3.算法组件层接口/README.md
@@ -8,15 +8,16 @@
 
 关于接口 API 内容如有问题可以联系我们，联系方式如下：
 
-| 姓名   | 单位             | 联系方式                                                  |
-| ------ | ---------------- | --------------------------------------------------------- |
-| 丁亚丹 | 中国银联         | dingyadan@unionpay.com       |
-| 刘瑞   | 上海浦东发展银行 | liur29@spdb.com.cn               |
-| 龚乐诚 | 上海浦东发展银行 | gonglc@spdb.com.cn            |
-| 靳新   | 洞见科技         | jinxin@insightone.cn          |
-| 赵永坤 | 洞见科技         | zhaoyongkun@insightone.cn|
-| 马煜翔 | 蓝象智联         | zichen.ma@trustbe.cn          |
-| 王超   | 蓝象智联         | congying.wang@trustbe.cn   |
+| 姓名   | 单位             | 联系方式                  |
+| ------ | ---------------- | ------------------------- |
+| 丁亚丹 | 中国银联         | dingyadan@unionpay.com    |
+| 谢袁源 | 中国银联         | xieyuanyuan@unionpay.com  |
+| 刘瑞   | 上海浦东发展银行 | liur29@spdb.com.cn        |
+| 龚乐诚 | 上海浦东发展银行 | gonglc@spdb.com.cn        |
+| 靳新   | 洞见科技         | jinxin@insightone.cn      |
+| 赵永坤 | 洞见科技         | zhaoyongkun@insightone.cn |
+| 马煜翔 | 蓝象智联         | zichen.ma@trustbe.cn      |
+| 王超   | 蓝象智联         | congying.wang@trustbe.cn  |
 
 ## 目录结构
 
@@ -25,7 +26,7 @@ InterOp
 ├─ LICENSE
 ├─ README.md              # 互联互通统一框架，贡献单位，版权声明等                  
 └─ 互联互通集成对接指引      # 存放对接指引，注意事项等相关内容
-└─ 互联互通API接口文档
+└─ 互联互通API接口规范
     ├─ README.md          # 子模块概述，Contributor联系方式等  
     └─ 算法组件层接口
         ├── README.md     # 模块简介，Contributor联系方式等                     

diff --git a/API_SPECS/3.算法组件层接口/隐私计算互联互通算法组件层API.md b/API_SPECS/3.算法组件层接口/隐私计算互联互通算法组件层API.md
@@ -49,7 +49,7 @@
 **文档版本**
 
 ```
-v1.0.0
+v1.1.0
 ```
 
 ## 2 算法组件自描述文件
@@ -449,13 +449,13 @@ x-mprac-token-set：  required 多方资源访问控制的许可凭证，用于
 
 #### 3.1.3  公共出参
 
-状态码 **200**
+状态码 **0**
 
-| 名称 | 类型   | 必选 | 中文名       | 说明               |
-| ---- | ------ | ---- | ------------ | ------------------ |
-| code | int32  | true | 状态码       | 200 正常，否则错误 |
-| msg  | string | true | 错误信息     | none               |
-| data | object | true | 响应数据内容 | none               |
+| 名称 | 类型   | 必选 | 中文名       | 说明             |
+| ---- | ------ | ---- | ------------ | ---------------- |
+| code | int32  | true | 状态码       | 0 正常，否则错误 |
+| msg  | string | true | 错误信息     | none             |
+| data | object | true | 响应数据内容 | none             |
 
 ### 3.2 接口定义
 
@@ -487,25 +487,25 @@ x-mprac-token-set：  required 多方资源访问控制的许可凭证，用于
 
 | 状态码 | 状态码含义                                              | 说明 | 数据模型 |
 | ------ | ------------------------------------------------------- | ---- | -------- |
-| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
+| 0      | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 **返回数据结构**
 
-状态码 **200**
+状态码 **0**
 
 | 名称   | 类型    | 必选 | 约束 | 中文名   | 说明                     |
 | ------ | ------- | ---- | ---- | -------- | ------------------------ |
-| code   | integer | true | none | 状态码   | 200 正常，否则错误       |
+| code   | integer | true | none | 状态码   | 0 正常，否则错误         |
 | status | string  | true | none | 任务状态 | RUNNING、SUCCESS、FAILED |
 | role   | string  | true | none | 角色     | 任务节点所属角色         |
 
 > 返回示例
 
-> 200 Response
+> 0 Response
 
 ```json
 {
-  "code": 200,
+  "code": 0,
   "status": "RUNNING",
   "role": "host",
 }
@@ -518,7 +518,7 @@ x-mprac-token-set：  required 多方资源访问控制的许可凭证，用于
 | **标识名称**     | **可选性** | **标识含义**     | **描述**                                     |
 | ---------------- | ---------- | ---------------- | -------------------------------------------- |
 | system.storage   | 必选       | 存储层服务地址   | 支持配置多个存储服务地址                     |
-| system.callback  | 可选       | 调度层回调地址   | 可通过接口回调，也可通过容器运行结果，或其他 |
+| system.callback  | 必选     | 调度层回调地址   | 可通过接口回调，也可通过容器运行结果，或其他 |
 | system.transport | 必选       | 传输服务地址     | 填写传输地址信息                             |
 | system.compute   | 可选       | 计算引擎服务地址 | 填写引擎服务地址信息                         |
 | system.control_port   | 可选       | 信息查询端口 | 填写算法容器对外的信息查询端口，默认10086         |
@@ -861,7 +861,7 @@ x-ptp-target-inst-id:        optional 接收端机构编号，全网唯一
 
 **响应体**
 
-200 响应数据格式：JSON
+0 响应数据格式：JSON
 
 | 参数名称        | 数据类型      | 可选  | 描述                                                                                                                                                                                                                                                                                                                         |
 | --------------- | ------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -888,7 +888,7 @@ x-ptp-target-inst-id:        optional 接收端机构编号，全网唯一
 
 **响应体**
 
-200 响应数据格式：JSON
+0 响应数据格式：JSON
 
 | 参数名称        | 数据类型      | 可选  | 描述                               |
 | --------------- | ------------- | ----- | ---------------------------------- |
@@ -921,7 +921,7 @@ x-ptp-target-inst-id:        optional 接收端机构编号，全网唯一
 
 **响应体**
 
-200 响应数据格式：JSON
+0 响应数据格式：JSON
 
 | 参数名称        | 数据类型      | 可选  | 描述                                                                                                                                     |
 | --------------- | ------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------- |
@@ -956,7 +956,7 @@ x-ptp-target-inst-id:        optional 接收端机构编号，全网唯一
 
 **响应体**
 
-200 响应数据格式：JSON
+0 响应数据格式：JSON
 
 | 参数名称        | 数据类型      | 可选  | 描述                                                                                                                                                                                                                                                                                                                         |
 | --------------- | ------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/API_SPECS/4.传输层接口/隐私计算互联互通传输层API.md b/API_SPECS/4.传输层接口/隐私计算互联互通传输层API.md
@@ -28,7 +28,7 @@
 **文档版本**
 
 ```
-v1.0.0
+v1.1.0
 ```
 
 ## 2 节点间通信接口

diff --git a/API_SPECS/5.开放算法协议/隐私计算互联互通开放算法协议.md b/API_SPECS/5.开放算法协议/隐私计算互联互通开放算法协议.md
@@ -50,7 +50,7 @@ ECDH-PSI 算法整体框架如下图所示，共包括五个步骤：
 **文档版本**
 
 ```
-v1.0.0
+v1.1.0
 ```
 
 ## 2 算法层接口

diff --git a/GUIDE/README.md b/GUIDE/README.md
@@ -11,6 +11,7 @@
 | 姓名   | 单位     | 联系方式                                            |
 | ------ | -------- | --------------------------------------------------- |
 | 丁亚丹 | 中国银联 | dingyadan@unionpay.com|
+| 谢袁源 | 中国银联 | xieyuanyuan@unionpay.com |
 | 王思婷 | 招商银行         | w_siting@cmbchina.com       |
 | 刘瑞   | 上海浦东发展银行 | liur29@spdb.com.cn               |
 | 龚乐诚 | 上海浦东发展银行 | gonglc@spdb.com.cn            |
-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,7 @@ @@
     **文档版本**
     ```
-    v1.0.0
+    v1.1.0
     ```
     ## 2 节点间通信接口
@@ Expand Down @@