1.1K Star 6.2K Fork 5.2K

OpenHarmony / docs

 / 详情

[Bug]: 错误码易用性问题整改:401错误提示无法指导开发者定位解决问题

已拒绝
创建于  
2024-05-06 19:55

发生了什么问题?

错误码易用性问题整改

期望行为是什么?

1、401错误码对应的错误信息在JSDOC中的描述,按照接口实际可能返回的错误类型给出三类原因
Mandatory parameters are left unspecified(必选参数缺失)
Incorrect parameter types(参数类型不正确)
Parameter verification failed(参数规则校验失败)
eg:
Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed 

2、@ param 参数描述中补充完善参数描述限制
要求:在接口的参数描述中应将接口的使用场景,使用限制以及注意事项明确告知开发者

如何复现该缺陷

1、401错误码对应的错误信息在JSDOC中的描述,按照接口实际可能返回的错误类型给出三类原因
Mandatory parameters are left unspecified(必选参数缺失)
Incorrect parameter types(参数类型不正确)
Parameter verification failed(参数规则校验失败)
eg:
Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed 

2、@ param 参数描述中补充完善参数描述限制
要求:在接口的参数描述中应将接口的使用场景,使用限制以及注意事项明确告知开发者

其他补充信息

版本或分支信息

  • master
  • Release 4.1
  • Release 4.0
  • Release 3.2

评论 (1)

hxyang111111 创建了任务
hxyang111111 添加了
 
bug
标签
展开全部操作日志

感谢提交Issue!关于Issue的交互操作,请访问OpenHarmony社区支持命令清单。如果有问题,请联系 @NEEN @zengyawen @时睿 @Peter_1988 。如果需要调整订阅PR、Issue的变更状态,请访问链接

Thanks for submitting the issue. For more commands, please visit OpenHarmony Command List. If you have any questions, please refer to committer @NEEN @zengyawen @时睿 @Peter_1988 for help. If you need to change the subscription of a Pull Request or Issue, please visit the link.

openharmony_ci 添加了
 
waiting_for_assign
标签
hxyang111111 修改了描述
hxyang111111 修改了描述
hxyang111111 任务状态待办的 修改为已拒绝

登录 后才可以发表评论

状态
负责人
项目
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
预计工期 (小时)
参与者(2)
7387629 openharmony ci 1656582662
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs

搜索帮助

53164aa7 5694891 3bd8fe86 5694891