apple / apple/swift-openapi-generator

Support OpenAPI Overlay files

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

Description

Consider supporting OpenAPI Overlay (https://github.com/OAI/Overlay-Specification) files, which would make it easier to manage OpenAPI documents from upstream that need local modifications before passing them to the generator.

Not dissimilar to the support for external references - while both can be handled outside the generator, maybe there's better support we can provide here.

Contributor guide

Open the contributing guide

Research direction

No implementation files or tests are named. Start by reading the OpenAPI Overlay Specification and the generator's existing external-reference support, then determine where overlay application would fit before generation. Done means the generator can apply local overlays to upstream OpenAPI documents, with behavior and scope clarified first.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, swift
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.