mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

#4402 opened on Dec 25, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (26,187 stars) (2,542 forks)user submission
DocumentationHelp WantedUp for grabs

Description

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

Contributor guide

Tech stack
typescriptrest api
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
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.