Skip to content

Commit bbf85ed

Browse files
Merge dev into v3.3-dev-sync-with-dev
2 parents 75d0fae + 764f4bd commit bbf85ed

11 files changed

Lines changed: 74 additions & 28 deletions

.github/workflows/agenda.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
runs-on: ubuntu-latest
3131

3232
steps:
33-
- uses: actions/checkout@v6 # checkout repo content
33+
- uses: actions/checkout@v7 # checkout repo content
3434

3535
# we want to close old agenda issues before creating a new one because there's a limit of 3 pinned items on a repo
3636
- name: Close old agenda issues

.github/workflows/check-restricted-files.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
check-files:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/checkout@v6 # checkout repo content
17+
- uses: actions/checkout@v7 # checkout repo content
1818
with:
1919
fetch-depth: 0
2020

.github/workflows/inactive-issues.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
runs-on: ubuntu-latest
3030
name: Label issues with no recent activity
3131
steps:
32-
- uses: actions/checkout@v6
32+
- uses: actions/checkout@v7
3333
- run: scripts/label-no-recent.ps1
3434
shell: pwsh
3535
- run: scripts/close-no-recent.ps1

.github/workflows/respec.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
owner: OAI
2828
repositories: spec.openapis.org
2929

30-
- uses: actions/checkout@v6 # checkout main branch of this repo
30+
- uses: actions/checkout@v7 # checkout main branch of this repo
3131
with:
3232
fetch-depth: 0
3333

@@ -38,7 +38,7 @@ jobs:
3838
- name: Install dependencies
3939
run: npm ci
4040

41-
- uses: actions/checkout@v6 # checkout main branch of website repo
41+
- uses: actions/checkout@v7 # checkout main branch of website repo
4242
with:
4343
token: ${{ steps.generate-token.outputs.token }}
4444
repository: OAI/spec.openapis.org

.github/workflows/schema-publish.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
owner: OAI
3131
repositories: spec.openapis.org
3232

33-
- uses: actions/checkout@v6 # checkout main branch of this repo
33+
- uses: actions/checkout@v7 # checkout main branch of this repo
3434
with:
3535
fetch-depth: 0
3636

@@ -41,7 +41,7 @@ jobs:
4141
- name: Install dependencies
4242
run: npm ci
4343

44-
- uses: actions/checkout@v6 # checkout main branch of website repo
44+
- uses: actions/checkout@v7 # checkout main branch of website repo
4545
with:
4646
token: ${{ steps.generate-token.outputs.token }}
4747
repository: OAI/spec.openapis.org

.github/workflows/schema-tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
runs-on: ubuntu-latest
2020

2121
steps:
22-
- uses: actions/checkout@v6 # checkout repo content
22+
- uses: actions/checkout@v7 # checkout repo content
2323
with:
2424
fetch-depth: 0
2525

.github/workflows/sync-dev-to-vX.Y-dev.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
2727

2828
- name: Checkout repository
29-
uses: actions/checkout@v6
29+
uses: actions/checkout@v7
3030
with:
3131
fetch-depth: 0
3232
token: ${{ steps.generate-token.outputs.token }}

.github/workflows/sync-main-to-dev.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
2727

2828
- name: Checkout repository
29-
uses: actions/checkout@v6
29+
uses: actions/checkout@v7
3030
with:
3131
fetch-depth: 0
3232
token: ${{ steps.generate-token.outputs.token }}

.github/workflows/validate-markdown.yaml

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616

1717
steps:
18-
- uses: actions/checkout@v6 # checkout repo content
18+
- uses: actions/checkout@v7 # checkout repo content
1919

2020
- uses: actions/setup-node@v6 # setup Node.js
2121
with:
@@ -27,18 +27,3 @@ jobs:
2727
- name: Lint other files
2828
run: npx --yes markdownlint-cli2 *.md
2929

30-
# workaround for https://github.com/UmbrellaDocs/action-linkspector/issues/62
31-
- name: Install Chrome
32-
run: |
33-
sudo apt-get update
34-
sudo apt-get install -y google-chrome-stable
35-
echo "PUPPETEER_SKIP_DOWNLOAD=true" >> $GITHUB_ENV
36-
echo "PUPPETEER_EXECUTABLE_PATH=/usr/bin/google-chrome" >> $GITHUB_ENV
37-
38-
- name: Check links in markdown files
39-
uses: umbrelladocs/action-linkspector@v1
40-
with:
41-
config_file: .linkspector.yml
42-
reporter: github-check
43-
fail_level: any
44-
filter_mode: file

AI.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# OpenAPI Initiative AI Policy
2+
3+
The OpenAPI Initiative is a project that brings together experienced industry experts to collaborate on an open, shared standard that benefits us all.
4+
It is the result of shared ideas, thoughtful discussion, and careful curation over time.
5+
As the tools landscape changes, the way we work together on that shared vision should not change.
6+
7+
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.
8+
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.
9+
10+
TL;DR we do permit use of AI, with disclosure, but low-effort, inaccurate or overly verbose contributions will be dismissed.
11+
12+
## AI and Standards Development
13+
14+
The nature of this project provides a very particular context and any tool (including AI) should be applied with consideration to the context.
15+
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.
16+
17+
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.
18+
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.
19+
20+
## Permitted Use
21+
22+
AI tools may be used to support contributions to OpenAPI Initiative projects, including use of AI for drafting, editing, checking consistency, or exploring ideas.
23+
However, you are solely responsible for every part of your submission — the content, its accuracy, and its appropriateness for the project.
24+
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.
25+
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.
26+
27+
## Disclosure and Accountability
28+
29+
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.
30+
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.
31+
32+
You must be able to explain and defend every part of your contribution.
33+
If a reviewer asks why a particular design decision was made, "the AI suggested it" is not an acceptable answer.
34+
Contributions where the submitter cannot demonstrate understanding of the material will be closed without further discussion or explanation.
35+
36+
## Discussion Conduct
37+
38+
Discussions in OpenAPI Initiative projects are for humans.
39+
Comments that restate or summarise what has already been said, without advancing the conversation, add burden to volunteers and will be removed.
40+
A useful comment adds new information, identifies a constraint, asks a precise question, or proposes a concrete resolution.
41+
We expect you to make good-faith contributions that are concise and to the intended point; overly verbose or general contributions will be hidden or removed.
42+
43+
Do not use AI to generate issue comments, discussion replies, or PR descriptions. These are the primary record of design reasoning for the project; they must reflect genuine human thought.
44+
45+
Do not use AI to summarise discussion content and then reply to the summary. The individual points raised by the other participants all have value and the nuance is one of the main strengths of discussion between experts.
46+
47+
## Enforcement
48+
49+
Maintainers reserve the right to close any pull request, issue, or discussion thread that appears to represent low-effort or AI-generated content, without providing detailed justification.
50+
Repeated violations may result in a block from OpenAPI Initiative repositories.
51+
52+
Reviewer time and expertise are the scarcest resources this project has, and so this policy is there to protect them and ensure the long-term healthy and viability of the project.
53+
You are always welcome to reach out to us via GitHub or Slack to discuss any of these points or their application.
54+
55+
## Acknowledgements
56+
57+
This policy builds on and acknowledges the work of:
58+
59+
- [Mastodon AI Contribution Policy](https://github.com/mastodon/mastodon/blob/main/AI_POLICY.md)
60+
- [W3C: Use of Large Language Models in Standards Work](https://www.w3.org/TR/llms-standards/)
61+
- [FastAPI / tiangolo contributing guidelines](https://tiangolo.com/open-source/contributing/#automated-code-and-ai), in particular the framing of low-effort AI submissions as a denial-of-service attack on human effort

0 commit comments

Comments
 (0)