Update advices regarding Schema conformation. (#64)

* Update advices regarding Schema conformation.

* Update docs

* Update docs

* Update docs

* Update docs

* Update UIAF docs

---------

Co-authored-by: Masterain <[email protected]>
Co-authored-by: qhy040404 <[email protected]>

Author: 3 people

docs/.vuepress/navbar/en.ts

@@ -28,6 +28,11 @@ export const enNavbar = navbar([
         link: "https://github.com/Kamisato-Ayaka-233/mihoyo-api-collect",
         icon: "repo",
       },
+      {
+        text: "UIGF Schema Verify Tool",
+        link: "https://schema.uigf.org/",
+        icon: "tool"
+      }
     ],
   },
 ]);

docs/.vuepress/navbar/zh.ts

@@ -28,6 +28,11 @@ export const zhNavbar = navbar([
         link: "/zh/mihoyo-api-collection-project.html",
         icon: "api",
       },
+      {
+        text: "UIGF 格式校验工具",
+        link: "https://schema.uigf.org/",
+        icon: "tool"
+      }
     ],
   },
 ]);

docs/en/standards/srgf.md

@@ -49,6 +49,14 @@ Including only importing feature reduces the interchangeability of user data, an
 
 ## Json Schema
 
+::: warning Mind the Field Types
+Devs are strongly urged to respect the data types of each property in the schema. Using incorrect types could result in errors when parsing JSON files by other tools developed in strong typing programming languages, leading to data transfer failures.
+
+To avoid such issues, we recommend designing dedicated structs for the SRGF format or utilizing methods like `JsonNumberHandling.WriteAsString`. Additionally, it is advisable to design relevant unit tests to ensure consistency between imports and exports.
+
+We also provide the [SRGF Json Schema Verify Tool](https://schema.uigf.org/?schema=srgf) to help you to verify validation of Json files.
+:::
+
 ```json
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -122,7 +130,7 @@ Including only importing feature reduces the interchangeability of user data, an
           },
           "time": {
             "type": "string",
-            "description": "Time of item achieved"
+            "description": "Time when the item was obtained. This MUST BE THE String typed value captured intact from the gacha record webpage WITHOUT ANY CONVERTION TO ANY DATE TYPES. Any conversion of such can cause potential timezone mistakes if the device time zone differs from the server time zone, unless special treatments are applied by individual app devs."
           },
           "name": {
             "type": "string",

docs/en/standards/uiaf.md

@@ -38,6 +38,14 @@ All time in this standard are based on `UTC+8` time zone
 
 ## Json Schema
 
+::: warning Mind the Field Types
+Devs are strongly urged to respect the data types of each property in the schema. Using incorrect types could result in errors when parsing JSON files by other tools developed in strong typing programming languages, leading to data transfer failures.
+
+To avoid such issues, we recommend designing dedicated structs for the UIAF format or utilizing methods like `JsonNumberHandling.WriteAsString`. Additionally, it is advisable to design relevant unit tests to ensure consistency between imports and exports.
+
+We also provide the [UIAF Json Schema Verify Tool](https://schema.uigf.org/?schema=uiaf) to help you to verify validation of Json files.
+:::
+
 ```json
 {
   "$schema": "http://json-schema.org/draft-04/schema#",

docs/en/standards/uigf-legacy-v2.3.md

@@ -140,7 +140,7 @@ Item's in-game ID, refer to [UIGF API](../API.md) to get this data
             },
             "time": {
               "type": "string",
-              "title": "Time of item achieved"
+              "title": "Time when the item was obtained. "
             },
             "name": {
               "type": "string",

docs/en/standards/uigf.md

@@ -81,11 +81,19 @@ Please remember to add corresponding uigf_gacha_type field when applying UIGF fo
 
 ### `item_id`
 
-Item's in-game ID, refer to [UIGF API](../API.md) to get this data
+Item's in-game ID, refer to [UIGF API](../API.md) to get this data.
 
 ## Json Schema
 
-> UIGF-Org provides [Json Schema](/schema/uigf.json) for validation
+> UIGF-Org provides the following JSON Schema for the validation of the data structure.
+
+::: warning Mind the Field Types
+Devs are strongly urged to respect the data types of each property in the schema. Using incorrect types could result in errors when parsing JSON files by other tools developed in strong typing programming languages, leading to data transfer failures.
+
+To avoid such issues, we recommend designing dedicated structs for the UIGF format or utilizing methods like `JsonNumberHandling.WriteAsString`. Additionally, it is advisable to design relevant unit tests to ensure consistency between imports and exports.
+
+We also provide the [UIGF Json Schema Verify Tool](https://schema.uigf.org/?schema=uigf) to help you to verify validation of Json files.
+:::
 
 ```json
 {
@@ -156,7 +164,7 @@ Item's in-game ID, refer to [UIGF API](../API.md) to get this data
           },
           "time": {
             "type": "string",
-            "title": "Time when the item was obtained"
+            "title": "Time when the item was obtained. This MUST BE THE String typed value captured intact from the gacha record webpage WITHOUT ANY CONVERTION TO ANY DATE TYPES. Any conversion of such can cause potential timezone mistakes if the device time zone differs from the server time zone, unless special treatments are applied by individual app devs."
           },
           "name": {
             "type": "string",

docs/zh/standards/srgf.md

@@ -48,6 +48,14 @@ head:
 
 ## Json Schema
 
+::: warning 注意字段类型
+请各位开发者务必尊重 Schema 内定义的字段类型。使用错误的类型可能会导致其它由强类型编程语言制成的工具在解析 Json 文件时产生错误，进而导致数据转移失败。
+
+为了避免这类问题，我们建议您针对 SRGF 格式设计专用的 struct，或善用 `JsonNumberHandling.WriteAsString` 等方法。同时，设计相关的单元测试以确保导入导出的一致性。
+
+我们也提供 [SRGF 格式校验工具](https://schema.uigf.org/?schema=srgf)来帮助你校验 Json 文件。
+:::
+
 ```json
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -121,7 +129,7 @@ head:
           },
           "time": {
             "type": "string",
-            "description": "获取物品的时间"
+            "description": "获取物品的时间，应为「抽卡记录网页上显示的原始时间字符串」而非任何转换过的值。如果设备时区与服务器时区不一致，任意类型转换将会导致时区转换出现误差（除非应用进行了特殊处理）。"
           },
           "name": {
             "type": "string",

docs/zh/standards/uiaf.md

@@ -38,6 +38,14 @@ head:
 
 ## Json Schema
 
+::: warning 注意字段类型
+请各位开发者务必尊重 Schema 内定义的字段类型。使用错误的类型可能会导致其它由强类型编程语言制成的工具在解析 Json 文件时产生错误，进而导致数据转移失败。
+
+为了避免这类问题，我们建议您针对 UIAF 格式设计专用的 struct，或善用 `JsonNumberHandling.WriteAsString` 等方法。同时，设计相关的单元测试以确保导入导出的一致性。
+
+我们也提供 [UIAF 格式校验工具](https://schema.uigf.org/?schema=uiaf)来帮助你校验 Json 文件。
+:::
+
 ```json
 {
   "$schema": "http://json-schema.org/draft-04/schema#",

docs/zh/standards/uigf.md

@@ -63,7 +63,7 @@ App 不应假定 `region_time_zone` 的值为上表中给出的值，应具有
 
 由于存在会共享保底与概率的卡池，所以需要一个额外的字段来界定  
 我们在 `UIGF` 的所有格式中注入了 `uigf_gacha_type` 字段  
-在导出到 `UIGF` 格式时需要注意添加对应的 `uigf_gacha_type` 字段  
+在导出到 `UIGF` 格式时需要注意添加对应的 `uigf_gacha_type` 字段。
 
 #### 映射关系
 
@@ -77,11 +77,19 @@ App 不应假定 `region_time_zone` 的值为上表中给出的值，应具有
 
 ### `item_id`
 
-物品游戏内ID，你可以通过 [UIGF API](../api.md) 获取这一数据
+物品游戏内ID，你可以通过 [UIGF API](../api.md) 获取这一数据。
 
 ## Json Schema
 
-> UIGF-Org 提供[Json Schema](/schema/uigf.json) 用于验证
+> UIGF-Org 提供下述 Json Schema 以用于验证资料结构的正确性。
+
+::: warning 注意字段类型
+请各位开发者务必尊重 Schema 内定义的字段类型。使用错误的类型可能会导致其它由强类型编程语言制成的工具在解析 Json 文件时产生错误，进而导致数据转移失败。
+
+为了避免这类问题，我们建议您针对 UIGF 格式设计专用的 struct，或善用 `JsonNumberHandling.WriteAsString` 等方法。同时，设计相关的单元测试以确保导入导出的一致性。
+
+我们也提供 [UIGF 格式校验工具](https://schema.uigf.org/?schema=uigf)来帮助你校验 Json 文件。
+:::
 
 ```json
 {
@@ -152,7 +160,7 @@ App 不应假定 `region_time_zone` 的值为上表中给出的值，应具有
           },
           "time": {
             "type": "string",
-            "title": "获取物品的时间"
+            "description": "获取物品的时间，应为「抽卡记录网页上显示的原始时间字符串」而非任何转换过的值。如果设备时区与服务器时区不一致，任意类型转换将会导致时区转换出现误差（除非应用进行了特殊处理）。"
           },
           "name": {
             "type": "string",