jmcarp / jmcarp/flask-apispec

How to declare Header Parameters

Open
#38 3 comments 4 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
652
Forks
151
PR merge metrics
No merged PRs in 30d

Description

How to document header parameters, for instance, an `Authorization` header for dealing with Http Authentication?
The same applies for an Authentication token required in the headers, how should I document this and use the Swagger UI?

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points. Start by locating the project's documentation and Swagger UI integration for header parameters and authentication; done means documenting how to declare an Authorization header or authentication token and use it through Swagger UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, authentication
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.