Doc: API docs don't mention the headers correctly · mattermost-community/focalboard#4402 | Good First Issue

(5 comments) (0 reactions) (0 assignees)TypeScript (2,542 forks)user submission

DocumentationHelp WantedUp for grabs

Repository metrics

Stars: (26,187 stars)
PR merge metrics: (30d に merged 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
Issue 種別: ドキュメント
難度: 2
推定時間: 1-3時間
活動状況: アクティブ
明確さ: 明確
前提条件: GitSwagger/OpenAPI
初心者向け度: 80