swagger-api / swagger-api/swagger-ui

OpenAPI 3.1.0 support: mutualTLS support

Open
#8,020 2 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: feature version: 5.x
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

How can we help?

Hi Swagger,
Amazon API Gateway released mutual TLS authentication for Amazon API Gateway:
https://aws.amazon.com/blogs/compute/introducing-mutual-tls-authentication-for-amazon-api-gateway/

So now we need to provide the .key and .cert file as part of the request:

curl --key my_client.key --cert my_client.pem https://api.yourdomain.com

Does swagger-ui have any support for this?

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

No files, tests, or entry points are identified in the issue. Start by locating Swagger UI's request-generation path and its OpenAPI 3.1 handling, then determine how mutual TLS certificate and key inputs should be represented and tested. Done means Swagger UI supports the requested .key and .cert inputs for requests with coverage for the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.