marshmallow-code / marshmallow-code/apispec

Support Overlays standard

Open
#981 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1.2k
Forks
202
Avg merge
3h 38m
Merged PRs (30d)
3

Description

There is a reasonably new formalised standard out called "Overlays - https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md 2024-10-17 .

Currently, I can generate my openapi definition from the code, then add a few tweaks to it, commit this to a documentation site, but the second the source code changes, then one has to manually add in the tweaks again, repeat this process for every update.

This standard helps a lot with that, since now, using something like - https://github.com/lornajane/openapi-overlays-js - then any additional changes can be kept in a seperate file, then added back in when we want to add it.

Currently, if there is an issue with the generator, or you just want to add in some new properties to the auto-generated code, then you either have to fix this repo or then use a 3rd party tool to then join the two back together again.

Might be nice to add in an overlay merging step, but if this is outside the scope of this project, then that's also fine since adding more features (even if pulling in a library for most of it) does distract from the main scope of this project.

Or probably one to make a plugin that is compatible with this library and then can be added to the [Ecosystem page](https://github.com/marshmallow-code/apispec/wiki/Ecosystem)?

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 by reading the linked Overlays 1.0.0 specification and the openapi-overlays-js project, then inspect how apispec generates and exposes its OpenAPI definition. Clarify whether the desired outcome is an integrated overlay-merging step or a separate compatible plugin listed on the Ecosystem page.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api
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.