Huawei LiteOS（以下简称LiteOS）欢迎开发者参与到开源社区的贡献中来，本文主要介绍参与LiteOS文档贡献的写作规范，如果贡献者提交文档的修改或提交新的文档，请参照此规范。如需提交新的文档，在LiteOS代码仓doc目录下创建新的.md文件，命名需遵循xxx_xxx.md格式，根据文档的内容来声明。比如介绍写作规范的文档，

查看更多 →

Lua脚本编写规范 Lua是一种脚本语言，目的是为了嵌入应用程序中，为应用程序提供灵活的扩展和定制功能。GeminiDB Redis使用的是Lua5.1.5版本，与开源Redis5.0使用的Lua版本是一致的。 使用Lua脚本时，需要经过谨慎的校验，否则可能出现死循环、业务超时等情况，甚至会导致业务不可用。

查看更多 →

测试用例编写规范 用例总体规范 用例命名规则 用例编号规则 用例描述编写规则 测试类型选择规则 测试用例等级选择规则 用例前置条件、测试步骤、预期结果文字表达规则

查看更多 →

对外API规范 API规范示例 为了对外API在调用时有用户信息，API调用时需要在header中传递Modifier、Creator字段。 值格式为：用户名+空格+用户id，如图1所示。 图1 示例 具有AccessControlled功能的实体，其API做了权限管控，权限管理

查看更多 →

编写接口自动化脚本 背景信息 接口自动化用例可包括三个阶段：准备阶段、测试阶段、销毁阶段。 准备阶段对应页面中的“前置步骤”，实现测试前置条件的准备；测试阶段对应“测试步骤”，实现接口的功能测试；销毁阶段对应“后置步骤”，实现准备阶段和测试阶段测试数据的释放或恢复。 准备阶段（可选）：前置步骤。

查看更多 →

应用对接接口规范 若首次与MIW应用对接，请跳过本章内容，从接入准备工作章节开始查看。 若已与MIW应用对接，请联系华为工程师确认对接接口规范，并按下列步骤进行操作： 对接基础接口。 对接基础接口前需要完成接入准备工作的操作，对接基础接口详细指导请参考对接联营基础接口。 调试基础接口。

查看更多 →

SQL编写 DDL 【建议】在 GaussDB (DWS)中，建议DDL（建表、comments等）操作统一执行，在批处理作业中尽量避免DDL操作。避免大量并发事务对性能的影响。 【建议】在非日志表（unlogged table）使用完后，立即执行数据清理（truncate）操作。因

查看更多 →

SQL编写 DDL 在GaussDB中，建议DDL（建表、COMMENT等）操作统一执行。在批处理作业中尽量避免DDL操作，避免大量并发事务对性能的影响。 在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因为在异常场景下，GaussDB不保证非日志表(unlogged

查看更多 →

SQL编写 DDL 【建议】在GaussDB中，建议DDL（建表、comments等）操作统一执行，在批处理作业中尽量避免DDL操作。避免大量并发事务对性能的影响。 【建议】在非日志表（unlogged table）使用完后，立即执行数据清理（truncate）操作。因为在异常场

查看更多 →

SQL编写 DDL 在GaussDB中，建议DDL（建表、COMMENT等）操作统一执行。在批处理作业中尽量避免DDL操作，避免大量并发事务对性能的影响。 在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因为在异常场景下，GaussDB不保证非日志表(unlogged

查看更多 →

应用对接接口规范 若首次与MIW应用对接，请跳过本章内容，从接入准备工作章节开始查看。 若已与MIW应用对接，请联系华为工程师确认对接接口规范，并按下列步骤进行操作： 对接License接口。 对接License接口前需要完成接入准备工作的操作，对接License接口详细指导请参考对接License接口。

查看更多 →

对外更新文档接口 功能介绍 对外更新文档接口。 URI POST /pdmdocumentservice/services/openapi/doc/v2/updateDoc 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 input 否 OpenUpdateDocumentVO

查看更多 →

SQL编写 DDL 【建议】在GaussDB(DWS)中，建议DDL（建表、comments等）操作统一执行，在批处理作业中尽量避免DDL操作。避免大量并发事务对性能的影响。 【建议】在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因

查看更多 →

SQL编写 DDL 在GaussDB中，建议DDL（建表、COMMENT等）操作统一执行。在批处理作业中尽量避免DDL操作，避免大量并发事务对性能的影响。 在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因为在异常场景下，GaussDB不保证非日志表(unlogged

查看更多 →

SQL编写 DDL 【建议】在GaussDB中，建议DDL（建表、comments等）操作统一执行，在批处理作业中尽量避免DDL操作。避免大量并发事务对性能的影响。 【建议】在非日志表（unlogged table）使用完后，立即执行数据清理（truncate）操作。因为在异常场

查看更多 →

SQL编写 DDL 在GaussDB中，建议DDL（建表、COMMENT等）操作统一执行。在批处理作业中尽量避免DDL操作，避免大量并发事务对性能的影响。 在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因为在异常场景下，GaussDB不保证非日志表(unlogged

查看更多 →

附录-API治理规范指导 概述 规范要求 工具平台

查看更多 →

API接口 KooMessage 是否支持集成到第三方产品中？ KooMessage的API是否存在对调用IP的限制？

查看更多 →

API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题： 新版应用开发指导

查看更多 →

API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题： 经典版应用开发指导

查看更多 →

API接口 鉴权 任务管理 公共-待办管理 人员管理 智能安监 问题管理 许可(工作票)管理 项目管理 消息及短信 基础数据管理 组织管理 作业对象管理 业务配置 EHS视频工单管理 生产资料管理 打卡管理 课程和积分管理 数据分析 权限角色 报表管理

查看更多 →