OpenAPI-Specification/AI.md at main · OAI/OpenAPI-Specification · GitHub
//blob/show" data-turbo-transient="true" />
Skip to content
Search or jump to...
Search code, repositories, users, issues, pull requests...
-->
Search
Clear
Search syntax tips
Provide feedback
--><br>We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel
Submit feedback
Saved searches
Use saved searches to filter your results more quickly
-->
Name
Query
To see all available qualifiers, see our documentation.
Cancel
Create saved search
Sign in
//blob/show;ref_cta:Sign up;ref_loc:header logged out"}"<br>Sign up
Appearance settings
Resetting focus
You signed in with another tab or window. Reload to refresh your session.<br>You signed out in another tab or window. Reload to refresh your session.<br>You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading. Please reload this page.
OAI
OpenAPI-Specification
Public
Notifications<br>You must be signed in to change notification settings
Fork<br>9.2k
Star<br>31.1k
FilesExpand file tree
main
/AI.md
Copy path
Blame<br>More file actions
Blame<br>More file actions
Latest commit
History<br>History<br>History
61 lines (40 loc) · 4.9 KB
main
/AI.md
Copy path
Top
File metadata and controls<br>Preview
Code
Blame
61 lines (40 loc) · 4.9 KB
Raw<br>Copy raw file<br>Download raw file
OutlineEdit and raw actions
OpenAPI Initiative AI Policy
The OpenAPI Initiative is a project that brings together experienced industry experts to collaborate on an open, shared standard that benefits us all.<br>It is the result of shared ideas, thoughtful discussion, and careful curation over time.<br>As the tools landscape changes, the way we work together on that shared vision should not change.
Well-thought-out and meaningful contributions will always be welcome and considered for their merits, however the advent of AI-generated interactions makes this policy a necessary addition to the project.<br>We encourage humans to engage and to gain experience with the project and further the mission, but our volunteer maintainers are not to be put in a position of expending more effort on reviewing contributions than was used to create them because the project is unsustainable in that scenario.
TL;DR we do permit use of AI, with disclosure, but low-effort, inaccurate or overly verbose contributions will be dismissed.
AI and Standards Development
The nature of this project provides a very particular context and any tool (including AI) should be applied with consideration to the context.<br>The tools you use day-to-day can feel helpful, but we expect you to consider how they may best add value to each task within the project.
Standards development means devising and developing standards that do not yet exist, with knowledge of the standards landscape and ongoing work in other standards projects.<br>Most AI tools are trained on existing or outdated content, making them less useful for standards development than they might be in other applications, so bear that perspective in mind when working with AI on specification improvements or proposals.
Permitted Use
AI tools may be used to support contributions to OpenAPI Initiative projects, including use of AI for drafting, editing, checking consistency, or exploring ideas.<br>However, you are solely responsible for every part of your submission — the content, its accuracy, and its appropriateness for the project.<br>You should expect to be asked followup questions about any detail of your contribution and to have already considered your work as deeply as our maintainers will when they review it.<br>Using AI can help you to do a good job but we expect you to use these tools intentionally and considerately for the project and audience.
Disclosure and Accountability
If AI tools were used in preparing a contribution beyond simple autocomplete or spellcheck, this must be disclosed in the pull request or issue description.<br>Add a note with a simple overview of how AI was used to your work and be prepared to answer further questions on that usage.
You must be able to explain and defend every part of your contribution.<br>If a reviewer asks why a particular design decision was made, "the AI suggested it" is not an acceptable answer.<br>Contributions where the submitter cannot demonstrate understanding of the material will be closed without further discussion or explanation.
Discussion Conduct
Discussions in OpenAPI Initiative projects are for humans.<br>Comments that restate or summarise what has already been said, without advancing the conversation, add burden to volunteers and will be removed.<br>A useful comment adds new information, identifies a constraint, asks a precise question, or proposes a concrete resolution.<br>We expect you to make good-faith contributions that are concise and to the intended point; overly verbose or general contributions will...