swagger-api / swagger-api/swagger-ui

Digest access authorization

Open
#8,264 8 comments 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Content & configuration

Swagger/OpenAPI definition:

openapi: 3.0.3
info:
 title: Some API
 version: 1.0.0
paths:
 /foo:
   get:
     responses:
       '200':
         description: Some description
components:
 securitySchemes:
   digestAuth:
     type: http
     scheme: digest
security:
 - digestAuth: []

Is your feature request related to a problem?

When trying to authorize using Swagger UI I get digestAuth HTTP authentication: unsupported scheme 'digest' displayed in the UI. I'm guessing that digest auth isn't supported?

Describe the solution you'd like

I would like digest auth to work against devices that support the protocol.

Describe alternatives you've considered

I'm open to contribute this functionality if you deem that digest auth is applicable to this project.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Swagger/OpenAPI securitySchemes example and the Swagger UI authorization flow that reports unsupported scheme 'digest'. Check how existing HTTP authentication schemes are handled, then verify the example against a device supporting digest authentication; done means digest authorization works without the unsupported-scheme error.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
authentication, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.