Skip to content

Commit

Permalink
chroe: update swagger api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
icyleaf committed Dec 2, 2024
1 parent 37b4c67 commit c067d7d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 66 deletions.
47 changes: 14 additions & 33 deletions swagger/v1/swagger_en.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,7 @@
"/apps/version_exist": {
"get": {
"summary": "Check version build exists",
"security": [

],
"security": [],
"tags": [
"Apps"
],
Expand Down Expand Up @@ -185,9 +183,7 @@
"/apps/versions": {
"get": {
"summary": "Get version builds",
"security": [

],
"security": [],
"tags": [
"Apps"
],
Expand Down Expand Up @@ -231,9 +227,7 @@
"/apps/latest": {
"get": {
"summary": "Get the latest builds",
"security": [

],
"security": [],
"tags": [
"Apps"
],
Expand Down Expand Up @@ -300,9 +294,7 @@
],
"description": "Upload a iOS, Android, macOS, Windows or Linux App",
"operationId": "uploadApp",
"parameters": [

],
"parameters": [],
"responses": {
"201": {
"description": "Upload an App",
Expand Down Expand Up @@ -1017,9 +1009,7 @@
"/debug_files": {
"get": {
"summary": "List debug files",
"security": [

],
"security": [],
"tags": [
"Debug files"
],
Expand Down Expand Up @@ -1066,9 +1056,7 @@
"/debug_files/download": {
"get": {
"summary": "Download debug file",
"security": [

],
"security": [],
"tags": [
"Debug files"
],
Expand Down Expand Up @@ -1235,9 +1223,7 @@
],
"description": "Upload a dSYM or Proguard file which it was archived with zip formatted whit it accepts:\n\n- `iOS`: a Zipped dSYM file\n- `Android`: a Zipped file includes mapping.txt, R.txt or AndroidManifest.xml files.\n",
"operationId": "uploadDebugFile",
"parameters": [

],
"parameters": [],
"responses": {
"200": {
"description": "Upload a debug file",
Expand Down Expand Up @@ -2074,9 +2060,7 @@
"/version": {
"get": {
"summary": "Get version information",
"security": [

],
"security": [],
"tags": [
"Version"
],
Expand All @@ -2099,9 +2083,7 @@
},
"security": [
{
"token": [

]
"token": []
}
],
"components": {
Expand Down Expand Up @@ -2926,8 +2908,7 @@
"type": "object",
"required": [
"name",
"device_type",
"download_filename_type"
"device_type"
],
"properties": {
"name": {
Expand Down Expand Up @@ -2965,10 +2946,10 @@
"download_filename_type": {
"type": "string",
"enum": [
"system",
"original"
"version_datetime",
"original_filename"
],
"description": "Download filename type"
"description": "Download file name type"
}
}
},
Expand Down Expand Up @@ -3257,4 +3238,4 @@
}
}
}
}
}
47 changes: 14 additions & 33 deletions swagger/v1/swagger_zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,7 @@
"/apps/version_exist": {
"get": {
"summary": "检查应用版本是否存在",
"security": [

],
"security": [],
"tags": [
"应用"
],
Expand Down Expand Up @@ -185,9 +183,7 @@
"/apps/versions": {
"get": {
"summary": "应用渠道的上传版本列表",
"security": [

],
"security": [],
"tags": [
"应用"
],
Expand Down Expand Up @@ -231,9 +227,7 @@
"/apps/latest": {
"get": {
"summary": "搜索指定版本后面的应用版本列表",
"security": [

],
"security": [],
"tags": [
"应用"
],
Expand Down Expand Up @@ -300,9 +294,7 @@
],
"description": "上传 iOS、Android、macOS、Linux 或 Windows 应用",
"operationId": "uploadApp",
"parameters": [

],
"parameters": [],
"responses": {
"201": {
"description": "已上传的应用版本详情",
Expand Down Expand Up @@ -1017,9 +1009,7 @@
"/debug_files": {
"get": {
"summary": "获取调试文件列表",
"security": [

],
"security": [],
"tags": [
"调试文件"
],
Expand Down Expand Up @@ -1066,9 +1056,7 @@
"/debug_files/download": {
"get": {
"summary": "下载调试文件",
"security": [

],
"security": [],
"tags": [
"调试文件"
],
Expand Down Expand Up @@ -1235,9 +1223,7 @@
],
"description": "上传 dSYM 或 Proguard 打包成 zip 压缩调试文件\n\n- `iOS`: 使用 Zip 压缩后的 dSYM 文件\n- `Android`: 使用 Zip 压缩后包含 mapping.txt、R.txt 和 AndroidManifest.xml 的文件\n",
"operationId": "uploadDebugFile",
"parameters": [

],
"parameters": [],
"responses": {
"200": {
"description": "调试文件详情",
Expand Down Expand Up @@ -2074,9 +2060,7 @@
"/version": {
"get": {
"summary": "获取版本信息",
"security": [

],
"security": [],
"tags": [
"版本"
],
Expand All @@ -2099,9 +2083,7 @@
},
"security": [
{
"token": [

]
"token": []
}
],
"components": {
Expand Down Expand Up @@ -2926,8 +2908,7 @@
"type": "object",
"required": [
"name",
"device_type",
"download_filename_type"
"device_type"
],
"properties": {
"name": {
Expand Down Expand Up @@ -2965,10 +2946,10 @@
"download_filename_type": {
"type": "string",
"enum": [
"system",
"original"
"version_datetime",
"original_filename"
],
"description": "下载文件文件名的生成规则"
"description": "下载文件的文件名生成规则"
}
}
},
Expand Down Expand Up @@ -3257,4 +3238,4 @@
}
}
}
}
}

0 comments on commit c067d7d

Please sign in to comment.