apple / apple/swift-openapi-generator

Support for security scheme/auth

Open
#37 27 comments 24 reactions 0 assignees View on GitHub
area/openapi kind/feature status/needs-design
Dominant language
Swift
Stars
2k
Forks
182
Avg merge
13h 28m
Merged PRs (30d)
5

Description

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object

Let's do a proposal first, as there are a few ways this could be implemented.

For now, the workaround is to write your own middleware that injects the appropriate headers to every outgoing request.

Example: https://github.com/apple/swift-openapi-generator/tree/main/Examples/auth-client-middleware-example

Contributor guide

Open the contributing guide

Research direction

Start by reading the OpenAPI 3.0.3 Security Scheme Object specification linked in the issue, then review the Swift auth-client-middleware-example. Compare the possible implementation approaches and produce a proposal that defines the intended security-scheme/auth support and its scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, swift
Domain
api, authentication, security, tooling
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.