mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

开放

#4,402 创建于 2022年12月25日

在 GitHub 查看贡献者指南
 (5 条评论) (0 个反应) (0 位负责人)TypeScript (2,542 个派生)user submission
DocumentationHelp WantedUp for grabs

仓库指标

星标
 (26,187 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Summary

The need to provide the X-Requested-With header and Authorization: Bearer <token> are missing from the swagger docs.

Link to documentation page

https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html

贡献者指南

研究方向
查看 Swagger/OpenAPI 规范文件并找到端点定义。将缺失的标头 'X Requested With' 和 'Authorization: Bearer <token>' 添加到相应的操作中。确保将这些标头记录为必填参数。
技术栈
typescriptrest api
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitSwagger/OpenAPI
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80