mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Aperta

#4402 aperta il 25 dic 2022

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)TypeScript (2542 fork)user submission
DocumentationHelp WantedUp for grabs

Metriche repository

Star
 (26.187 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il file di specifiche Swagger/OpenAPI e trova le definizioni degli endpoint. Aggiungi le intestazioni mancanti 'X Requested With' e 'Authorization: Bearer <token>' alle operazioni appropriate. Assicurati che queste intestazioni siano documentate come parametri obbligatori.
Tech stack
typescriptrest api
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitSwagger/OpenAPI
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80