mattermost-community/focalboard

Doc: API docs don't mention the headers correctly

Open

#4402 aperta il 25 dic 2022

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

Metriche repository

Star
 (26.187 star)
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
La richiesta prevede l'aggiunta dell'intestazione 'X Requested With' e dell'intestazione 'Authorization: Bearer <token>' alla documentazione Swagger dell'API. Il file pertinente si trova probabilmente nella directory server/swagger del repository, possibilmente in un file YAML o JSON che genera la documentazione HTML. Il contributore dovrebbe individuare il file di specifica Swagger (ad esempio openapi.yaml) e aggiungere le intestazioni mancanti alle definizioni degli endpoint appropriati. Nessun PR collegato o commento recente indica una soluzione.
Tech stack
typescriptrest api
Dominio
documentationapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
None
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95