mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

#4 402 ouverte le 25 déc. 2022

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)TypeScript (2 542 forks)user submission
DocumentationHelp WantedUp for grabs

Métriques du dépôt

Stars
 (26 187 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Examinez le fichier de spécification Swagger/OpenAPI et localisez les définitions des points de terminaison. Ajoutez les en têtes manquants 'X Requested With' et 'Authorization: Bearer <token>' aux opérations appropriées. Assurez vous que ces en têtes sont documentés comme paramètres obligatoires.
Stack technique
typescriptrest api
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitSwagger/OpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80