mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

#4,402 opened on Dec 25, 2022

View on GitHub
 (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
 (No merged PRs in 30d)

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

Research direction
Review the Swagger/OpenAPI specification file and locate the endpoint definitions. Add the missing headers 'X Requested With' and 'Authorization: Bearer <token>' to the appropriate operations. Ensure the headers are documented as required parameters.
Tech stack
typescriptrest api
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80