mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

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

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)TypeScript (26,187 star) (2,542 fork)user submission
DocumentationHelp WantedUp for grabs

描述

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

贡献者指南

技术栈
typescriptrest api
领域
documentationapi
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
None
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
95
研究方向
The issue requests adding the 'X Requested With' header and 'Authorization: Bearer <token>' header to the Swagger documentation for the API. The relevant file is likely located in the repository under the server/swagger directory, possibly in a YAML or JSON file that generates the HTML docs. The contributor should locate the Swagger specification file (e.g., openapi.yaml) and add the missing headers to the appropriate endpoint definitions. No linked PRs or recent comments indicate a solution.