AI Contributions #5209
Replies: 4 comments 6 replies
-
|
There is an existing LF policy that OpenAPI should leverage, and can build upon if needed.... |
Beta Was this translation helpful? Give feedback.
-
|
FWIW, I have recently added this boilerplate to READMEs of open source work that are primarily written/maintained by me:
i.e. you can still use AI, but I require full disclosure. |
Beta Was this translation helpful? Give feedback.
This comment has been minimized.
This comment has been minimized.
-
|
my 2 cents The OpenAPI Overlay Specification aims to provide a "standardized way to apply targeted modifications to an existing OpenAPI document without directly editing the source document. " (was this not the original goal????) Think of it as a patch or transformation layer that sits on top of a base OpenAPI spec. The core (IMHO) goals are: Separation of concerns — Keep the source (often auto-generated) OpenAPI document pristine while layering on additional or corrected metadata separately. This is especially useful when the base spec is generated from code annotations and you don't want to pollute the source with documentation-only concerns. Reusability — A single overlay can be applied to multiple versions of a spec, or multiple overlays can be composed together (e.g., one for documentation enrichment, one for gateway-specific extensions, one for audience-specific views). Non-destructive workflows — Teams that generate specs from code (e.g., using frameworks like Gin, FastAPI, or Postman's own tooling) often can't easily add rich descriptions, examples, or Targeted transformations — Using JSONPath-based targeting, an overlay can surgically add, replace, or remove fields on specific operations, parameters, schemas, etc., rather than requiring a full spec fork right????? |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
AI-assisted and AI-initiated contributions are becoming increasingly prevalent across the Open Source world.
I haven't seen any official guidance within this project around expectations for this flavor of contribution, and thought it might be prudent to get out ahead of the deluge.
In particular, I would like to provide clear guidance for contributors regarding:
Some starting guidelines I'd personally like to see:
Beta Was this translation helpful? Give feedback.
All reactions