mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

#4.402 geöffnet am 25. Dez. 2022

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (26.187 Stars) (2.542 Forks)user submission
DocumentationHelp WantedUp for grabs

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
None
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95
Research-Richtung
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.