docs: change json schema id

tuihub · Dec 20, 2023 · b015c75 · b015c75
1 parent d7739b2
commit b015c75
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/docs/prd_cn.md b/docs/prd_cn.md
@@ -222,12 +222,12 @@ sequenceDiagram
 用户权限：
 - `Admin`和`Normal`能够创建自己的`AppPackageSaveDataConfig`，可以选择公开给其他用户
 
-配置文件为有效的json字符串，schema定义：[v1](https://tuihub.github.io/protos/schemas/savedata/v1.json)（[示例](https://tuihub.github.io/protos/schemas/savedata/v1-exmaple.json)），[v2.1](https://tuihub.github.io/protos/schemas/savedata/v1.json)（[示例](https://tuihub.github.io/protos/schemas/savedata/v2.1-example.json)）  
+配置文件为有效的json字符串，schema定义：[v1](https://tuihub.github.io/protos/schemas/savedata/v1.json)（[示例](https://tuihub.github.io/protos/schemas/savedata/v1-exmaple.json)），[v2.1](https://tuihub.github.io/protos/schemas/savedata/v2.1.json)（[示例](https://tuihub.github.io/protos/schemas/savedata/v2.1-example.json)）  
 推荐使用最新schema
 
 #### Savedata Schema v1 说明
 
-- 配置文件必须声明schema
+- 配置文件必须声明`jsonSchemaId`，其值为该配置对应的Json Schema URL
 - 配置文件中不应出现schema定义以外的值
 - 每个`entry`包含了一个特定路径的配置，通常情况下仅需要一个
   - `pathMode`路径模式否则必须为相对路径，相对路径的起始路径由具体设置决定
@@ -240,7 +240,7 @@ sequenceDiagram
 
 #### Savedata Schema v2.1 说明
 
-- 配置文件必须声明schema
+- 配置文件必须声明`jsonSchemaId`，其值为该配置对应的Json Schema URL
 - 配置文件中不应出现schema定义以外的值
 - 存档文件应为一个标准`zip`格式的压缩文件，其中包含配置文件本体
 - `platform`项为存档使用的平台，目前只有`windows`

diff --git a/docs/schemas/savedata/v1-example.json b/docs/schemas/savedata/v1-example.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://tuihub.github.io/protos/schemas/savedata/v1.json",
+  "jsonSchemaId": "https://tuihub.github.io/protos/schemas/savedata/v1.json",
   "platform": "windows",
   "entries": [
     {

diff --git a/docs/schemas/savedata/v1.json b/docs/schemas/savedata/v1.json
@@ -1,5 +1,5 @@
 {
-    "$id": "https://github.com/tuihub/protos/schemas/savedata/v1",
+    "$id": "https://tuihub.github.io/protos/schemas/savedata/v1.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "title": "Save File Configs",
     "properties": {

diff --git a/docs/schemas/savedata/v2.1-example.json b/docs/schemas/savedata/v2.1-example.json
@@ -1,5 +1,5 @@
 {
-    "$schema": "https://tuihub.github.io/protos/schemas/savedata/v2.1.json",
+    "jsonSchemaId": "https://tuihub.github.io/protos/schemas/savedata/v2.1.json",
     "platform": "windows",
     "caseSensitive": false,
     "entries": [

diff --git a/docs/schemas/savedata/v2.1.json b/docs/schemas/savedata/v2.1.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://github.com/tuihub/protos/schemas/savedata/v2.1.json",
+    "$id": "https://tuihub.github.io/protos/schemas/savedata/v2.1.json",
     "title": "TuiHub Savedata Config V2.1",
     "description": "Json schema v2.1 for TuiHub savedata config.",
     "type": "object",