AI Contributions #5209
Replies: 11 comments 16 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 was marked as duplicate.
This comment was marked as duplicate.
-
|
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.
-
|
The Mastodon policy is worth a review: https://github.com/mastodon/.github/blob/main/AI_POLICY.md One nugget: "If a maintainer suspects you do not understand your PR, it will be closed immediately." |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
CHAOSS made a collection of policies which I didn't manage to read all of yet https://github.com/chaoss/wg-ai-alignment/tree/main/moderation#readme |
Beta Was this translation helpful? Give feedback.
-
|
notes: use of LLM ok (Initial) for PR, but replies (come from human) |
Beta Was this translation helpful? Give feedback.
-
|
Some additional examples:
|
Beta Was this translation helpful? Give feedback.
-
|
This one from the quarkus folks - https://github.com/quarkusio/quarkus/blob/main/AI_POLICY.md I think it is fair to say that we have enough examples to work with and derive our own. Thoughts??? |
Beta Was this translation helpful? Give feedback.
-
|
AI contributions to OpenAPI are a natural fit — OpenAPI already describes machine-readable interfaces, and agents are the primary consumers of those interfaces at scale. A few specific ways AI should change OpenAPI: 1. Agent authentication securityScheme: As discussed in #5267, agents need a securityScheme that captures: agent identity (Ed25519 keypair in did:key format), capability scope, and delegation chain. Current schemes (apiKey, oauth2, http) all assume a human holds the credential. Agents need to prove who they are and what they're authorized to do in a single, verifiable data structure. 2. Cost estimates in operation metadata: An agent deciding which endpoint to call needs to know the expected cost, not just the capability. Adding a 3. Retry hints for agents: Humans read 429 responses and wait. Agents should know how long to wait, whether to retry at all, and whether a cheaper alternative exists. A 4. Capability declarations at the spec level: An OpenAPI spec should declare what tasks it's optimized for ("bulk data extraction", "real-time lookups", "content generation") in a machine-readable format. Agents that need to discover APIs for specific use cases could use this for automated selection. More on agent-API interaction patterns: https://blog.kinthai.ai/221-agents-multi-agent-coordination-lessons |
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