forked from OAI/OpenAPI-Specification
-
Notifications
You must be signed in to change notification settings - Fork 0
[pull] main from OAI:main #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pull
wants to merge
1,208
commits into
StemmlerSisters:main
Choose a base branch
from
OAI:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
1208 commits
Select commit
Hold shift + click to select a range
20fe7a7
Merge pull request #4166 from ralfhandl/main-move-examples-to-test-fi…
ralfhandl 1ff6ab4
Examples are on learn.openapis.org
ralfhandl 89f9cda
Create schema-test-coverage.mjs
ralfhandl 1951300
Also import draft-04
ralfhandl 1cdc217
test script for schema coverage
ralfhandl f9cd70a
Use only pass cases for coverage
ralfhandl b980078
Merge pull request #4172 from ralfhandl/main-readme-no-examples
lornajane 7e96988
Merge pull request #4162 from ralfhandl/main-schema-publish
ralfhandl 3875a59
Update schema-publish.yaml
ralfhandl c1ce814
Add Karen
ralfhandl c2e9427
Merge pull request #4179 from ralfhandl/main-schema-publishing-adjust…
lornajane fdc83e6
Same reviewers as for schema publishing
ralfhandl bdf4619
Use GitHub project for contributor lists instead of a file
lornajane 3724024
Add criteria for minor and patch releases
lornajane 64600ce
Merge pull request #4180 from ralfhandl/main-respec-publish-pr-reviewers
lornajane 858f3a5
Add more context and some corrections to the style guide
lornajane e3bfb47
The schemas are (mostly) not metaschemas
handrews 53e9a05
Bump @hyperjump/json-schema from 1.9.8 to 1.9.9
dependabot[bot] f0ec262
Create symlinks for spec minor versions
ralfhandl ac6ba3d
Merge pull request #4190 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl a7cb73f
Merge remote-tracking branch 'upstream/main' into main-schema-test-co…
ralfhandl ff0fdec
Show validation errors if test instances
ralfhandl 1f2a389
Prettier
ralfhandl 31f66e7
make executable
ralfhandl 9e548a1
Merge pull request #4189 from handrews/non-meta
ralfhandl fdbaebf
Merge pull request #4182 from lornajane/remove-contributors
ralfhandl a0848b9
Updated mermaid branch diagram
handrews 7adb0eb
Update schema development process
handrews 5565f9b
Fix typo
handrews c1e2fda
Clarifications from review feedback.
handrews 46383f3
More explanation of branches.
handrews 78a020e
Refer to the CoC at the org level
earth2marsh fa8123a
Removing the standalone file in favor of the org template
earth2marsh c38539c
Bump vitest from 2.1.4 to 2.1.5
dependabot[bot] a0800fc
Merge pull request #4187 from lornajane/styles-docs
lornajane f3161e5
Merge pull request #4186 from handrews/reorg2
lornajane dd82d55
Apply suggestions from code review
lornajane 5dca9eb
Merge branch 'main' into formal-minor-patch-criteria
ralfhandl ead4862
Merge pull request #4201 from OAI/dependabot/npm_and_yarn/vitest-2.1.5
ralfhandl 84c49a8
Merge pull request #4184 from lornajane/formal-minor-patch-criteria
ralfhandl 714c742
Merge pull request #4200 from OAI/coc
lornajane b7683f9
Update PR template for new branching strategy.
handrews ae0cb32
Merge pull request #4204 from handrews/pr-template
lornajane bcc9f29
Fixes the CoC link in the agenda
earth2marsh bdf9337
Merge pull request #4205 from OAI/earth2marsh-patch-1
lornajane 362e974
No infix -latest
ralfhandl 24e306d
Link to minor spec version
ralfhandl 04eef46
Bump yaml from 2.6.0 to 2.6.1
dependabot[bot] 876e1b1
Merge pull request #4208 from OAI/dependabot/npm_and_yarn/yaml-2.6.1
ralfhandl 50103d8
Merge pull request #4173 from ralfhandl/main-schema-test-coverage
handrews f3a80da
Merge pull request #4191 from ralfhandl/main-spec-minor-version-symlinks
handrews 0996320
Merge pull request #4206 from ralfhandl/main-schema-spec-links
handrews e12d589
symlink to file in same directory
ralfhandl 546f329
Merge pull request #4213 from ralfhandl/main-fix-latest-spec-symlinks
handrews 4604a32
Bump markdownlint-cli from 0.42.0 to 0.43.0
dependabot[bot] 4a9c374
Merge pull request #4224 from OAI/dependabot/npm_and_yarn/markdownlin…
ralfhandl eed5f41
Bump vitest from 2.1.5 to 2.1.6
dependabot[bot] b16545e
Merge pull request #4227 from OAI/dependabot/npm_and_yarn/vitest-2.1.6
ralfhandl 42520b0
Bump vitest from 2.1.6 to 2.1.8
dependabot[bot] 0b24a52
Merge pull request #4236 from OAI/dependabot/npm_and_yarn/vitest-2.1.8
ralfhandl dae5523
Start refactoring contributor information: issues, discusssions, roles
lornajane 9b395fe
Fill in more missing sections and try to keep the ordering sane
lornajane 31af874
Remove the now-outdated DEVELOPMENT file, it is replaced by CONTRIBUTING
lornajane 4a81dcb
Add the style guide as a separate file
lornajane 28c5df3
Apply suggestions from code review
lornajane 299291f
Add better information about where the spec actually is in the repo
lornajane 775a13b
Bump c8 from 10.1.2 to 10.1.3
dependabot[bot] c9d669b
Merge pull request #4247 from OAI/dependabot/npm_and_yarn/c8-10.1.3
ralfhandl b9f244f
Apply suggestions from code review
lornajane 77b6518
Update markdown files from pull request feedback
lornajane 3326a4b
Merge pull request #4246 from lornajane/refactor-contributing-file
lornajane fd8a69f
Bump highlight.js from 11.10.0 to 11.11.0
dependabot[bot] b81346f
Merge pull request #4253 from OAI/dependabot/npm_and_yarn/highlight.j…
ralfhandl f8d8fe3
Bump respec from 35.1.2 to 35.2.1
dependabot[bot] 6fa56f3
Merge pull request #4256 from OAI/dependabot/npm_and_yarn/respec-35.2.1
ralfhandl 784e92f
Fix directory name of where we keep the spec
lornajane ba75c29
Merge pull request #4261 from lornajane/fix-spec-folder-naming
ralfhandl b3949bd
Separate main css from build script
Bellangelo f583ff9
Add dark mode styling
Bellangelo 15aee42
Enable dark mode functionality
Bellangelo c94652e
Update tests
Bellangelo 2e1267b
Update tests
Bellangelo 973999a
Preferred color is not always the selected one
Bellangelo a2394b1
Format code
Bellangelo 2372f30
Update tests
Bellangelo 2dc8bdf
Update tests
Bellangelo 3c8a5f6
Update tests
Bellangelo e25d753
Add dark.css contents directly to the main.css
Bellangelo 10c10bc
Materialize lists of editors per spec version
ralfhandl dbec407
Simplify symlink creation
ralfhandl d5f765e
Remove unnecessarily request
Bellangelo ffa5176
Update tests
Bellangelo 7027e0f
dark.css is used by the dark mode toggle in fixup.js
Bellangelo 866a199
Bump @hyperjump/json-schema from 1.9.9 to 1.10.0
dependabot[bot] acdc31c
Bump highlight.js from 11.11.0 to 11.11.1
dependabot[bot] 74cae4b
Bump yaml from 2.6.1 to 2.7.0
dependabot[bot] 49e7202
Merge pull request #4276 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl ee2dcc4
Merge pull request #4280 from OAI/dependabot/npm_and_yarn/highlight.j…
ralfhandl c47b1db
Merge pull request #4283 from OAI/dependabot/npm_and_yarn/yaml-2.7.0
ralfhandl 796ce1a
Merge pull request #4270 from ralfhandl/main-materialize-list-of-edit…
lornajane b4517c0
Bump respec from 35.2.1 to 35.2.2
dependabot[bot] 71e5119
Add checkboxes to the PR template to indicate if schema updates are n…
lornajane bba1da7
Merge pull request #4297 from lornajane/add-schema-update-checkboxes
ralfhandl 902e505
Merge pull request #4291 from OAI/dependabot/npm_and_yarn/respec-35.2.2
ralfhandl f420a3e
Bump vitest from 2.1.8 to 3.0.1
dependabot[bot] 38b83d0
Merge pull request #4308 from OAI/dependabot/npm_and_yarn/vitest-3.0.1
ralfhandl 8eddd20
Bump vitest from 3.0.1 to 3.0.3
dependabot[bot] 6455cb1
Bump @hyperjump/json-schema from 1.10.0 to 1.10.1
dependabot[bot] 0d83975
Merge pull request #4316 from OAI/dependabot/npm_and_yarn/vitest-3.0.3
ralfhandl c1c275d
Use branch-local package-lock.json
ralfhandl 10e9a01
Merge pull request #4317 from OAI/dependabot/npm_and_yarn/hyperjump/j…
handrews 245a4e2
Merge pull request #4318 from ralfhandl/workflows-use-branch-local-pa…
lornajane 2619d58
Bump vitest from 3.0.3 to 3.0.4
dependabot[bot] 4cc0e82
Merge pull request #4321 from OAI/dependabot/npm_and_yarn/vitest-3.0.4
ralfhandl 5495770
Update schema-tests.yaml: correct step description
ralfhandl 8cf00a4
Merge pull request #4322 from OAI/ralfhandl-patch-1
handrews 55f2da6
Bump markdownlint-cli from 0.43.0 to 0.44.0
dependabot[bot] d237e68
Merge pull request #4323 from OAI/dependabot/npm_and_yarn/markdownlin…
ralfhandl f84077c
Bump vitest from 3.0.4 to 3.0.5
dependabot[bot] 60e0d46
Merge pull request #4329 from OAI/dependabot/npm_and_yarn/vitest-3.0.5
ralfhandl ec2727f
Bump @hyperjump/json-schema from 1.10.1 to 1.11.0
dependabot[bot] 9a07bd0
Merge pull request #4332 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl 031d633
Merge pull request #4268 from Bellangelo/main-dark-mode
ralfhandl 9449ce8
Build single targets
duncanbeevers 639c6ca
fixup! Build single targets
duncanbeevers 06a89cd
Update scripts/md2html/build.sh
ralfhandl 8e3015a
Merge pull request #4342 from duncanbeevers/build-src-changes
ralfhandl 20a3024
Run respec without sandbox
ralfhandl d368f35
Describe publishing process
ralfhandl 72cb498
Bump vitest from 3.0.5 to 3.0.6
dependabot[bot] 57962a3
Merge pull request #4371 from OAI/dependabot/npm_and_yarn/vitest-3.0.6
ralfhandl 4f0379b
Merge pull request #4358 from OAI/ralfhandl-respec-no-sandbox
lornajane d27078e
Update CONTRIBUTING.md
lornajane f9a2302
Merge pull request #4363 from ralfhandl/main-contributing-schema-publish
lornajane e26c74c
Update style-guide.md
ralfhandl c7e9bd8
Merge pull request #4377 from OAI/ralfhandl-style-guide-yaml-comments
lornajane bb8aac5
Bump vitest from 3.0.6 to 3.0.7
dependabot[bot] ce098b8
Merge pull request #4381 from OAI/dependabot/npm_and_yarn/vitest-3.0.7
ralfhandl bb50d43
style guide: no requirements in "Examples" sections
ralfhandl 5bc34d8
Update agenda.md
duncanbeevers b5ab378
Merge pull request #4385 from duncanbeevers/patch-1
lornajane 4ffcb64
Update style-guide.md
ralfhandl 1dd2c02
Create sync-main-to-dev.yaml
ralfhandl 70a5c94
Other versions links in frontmatter
ralfhandl 3e40ee4
Merge pull request #4382 from OAI/ralfhandl-style-guide-no-requirements
lornajane 428007d
Merge pull request #4401 from ralfhandl/main-respec-other-versions
ralfhandl fa1f64a
Create check-restricted-files.yaml
ralfhandl 9f91e54
Google Tag Manager
ralfhandl a963ad6
Simplified approach
ralfhandl 249dcef
Merge pull request #4407 from ralfhandl/main-protect-files-simpler
lornajane b58c0a9
Add notes on the new workflow
lornajane 037ebed
check-restricted-files.yaml: check for allowed PRs
ralfhandl bc7aaf3
Merge pull request #4393 from OAI/main-workflow-sync-main-to-devf
lornajane 0932cde
Create sync-dev-to-vX.Y-dev.yaml
ralfhandl ac04d8f
Document new workflow
ralfhandl 79ff798
Merge pull request #4398 from OAI/main-workflow-sync-dev-to-vX.Y-dev
lornajane 5215c11
Bump vitest from 3.0.7 to 3.0.8
dependabot[bot] c4f0205
Merge pull request #4420 from OAI/dependabot/npm_and_yarn/vitest-3.0.8
ralfhandl f3c113a
Merge pull request #4409 from OAI/main-check-restricted-files-and-all…
miqui cb37ec7
Move old schemas to _archive_
ralfhandl 41b6657
Update CONTRIBUTING.md
ralfhandl 32ca940
Create README.md
ralfhandl 506cc68
Document release process
ralfhandl 2800909
Merge pull request #4436 from ralfhandl/main-sync-CONTRIBUTING.md
handrews 7f5e1cf
Merge pull request #4403 from ralfhandl/main-move-up-google-analytics
handrews dd92b6e
Merge pull request #4437 from ralfhandl/main-document-release-process
lornajane e008ba3
Bump vitest from 3.0.8 to 3.0.9
dependabot[bot] 8fd1a08
Merge pull request #4447 from OAI/dependabot/npm_and_yarn/vitest-3.0.9
ralfhandl d14327b
Update package.json
ralfhandl f0a2a2e
Update CONTRIBUTING.md
ralfhandl 7a4a5d5
Create adjust-release-branch.sh
ralfhandl 9ba315d
Make executable
ralfhandl 9c9506e
reactivate v3.0 schema tests
ralfhandl 1dd85b5
Update CONTRIBUTING.md
ralfhandl 9ad57f7
labels for auto-sync
ralfhandl 26b12e4
Merge pull request #4453 from ralfhandl/main-CONTRIBUTING.md-branch-d…
handrews 73b9809
Remove now obsolete reference to schemas in main
ralfhandl b1f703f
Mention in CONTRIBUTING.md
ralfhandl ac7946e
Hint for Windows users
ralfhandl 2c97294
Merge pull request #4435 from ralfhandl/main-clean-up-schemas
handrews d53c93c
Port from dev
ralfhandl ad176a5
Proposal for referencing Tag Objects with URIs.
handrews df96128
Bump respec from 35.2.2 to 35.2.3
dependabot[bot] 701f16f
Merge pull request #4482 from OAI/dependabot/npm_and_yarn/respec-35.2.3
ralfhandl b70d917
Update issue templates
ralfhandl 9dd22cf
Merge pull request #4462 from ralfhandl/main-contributing-windows
miqui 8a3f194
Merge pull request #4486 from OAI/ralfhandl-patch-1
miqui e09c356
Merge pull request #4481 from ralfhandl/main-sync-scripts-from-dev
miqui 930f40b
Merge pull request #4452 from ralfhandl/main-package.json-description
miqui a4b47df
Merge pull request #4454 from ralfhandl/main-adjust-release-branch
miqui d49cb6f
Bump respec from 35.2.3 to 35.3.0
dependabot[bot] 1b84b6f
Merge pull request #4491 from OAI/dependabot/npm_and_yarn/respec-35.3.0
ralfhandl 6337d5d
Update issue templates
ralfhandl bd6fff0
Update config.yml
ralfhandl 41fdb3b
Merge pull request #4493 from OAI/ralfhandl-issue-templates-1
ralfhandl c0f62c3
Rename report-an-error-in-the-specification.md to spec_bug_report.md
ralfhandl 742d96b
Rename contribute-to-the-registries-at-spec-openapis-org-registry.md …
ralfhandl bbafa53
Update CONTRIBUTING.md
ralfhandl 8be81a5
@lornajane's proposal
ralfhandl b9c0963
Merge pull request #4494 from OAI/ralfhandl-main-contributing-note
lornajane 25fc465
Merge pull request #4492 from OAI/ralfhandl-issue-templates
handrews 7d375dd
Document proposal rejection
handrews 66ab968
Guidance on bullet list styles
ralfhandl 1a1b49c
We do not need to see the instructions post-filing
handrews eb1edd6
Merge pull request #4504 from ralfhandl/main-style-guide-bullet-lists
lornajane beb56e0
Merge pull request #4506 from handrews/no-tick
handrews 4c82b31
Add highlight.js support for text/event-stream
handrews ec5892b
Add tests for text/event-stream highlighting
handrews 2a2627f
Merge pull request #4516 from handrews/event-stream-hljs
handrews e4c1283
Bump yaml from 2.7.0 to 2.7.1
dependabot[bot] eee5a65
Merge pull request #4523 from OAI/dependabot/npm_and_yarn/yaml-2.7.1
ralfhandl 0f229eb
Bump vitest from 3.0.9 to 3.1.1
dependabot[bot] 60b7861
Merge pull request #4527 from OAI/dependabot/npm_and_yarn/vitest-3.1.1
ralfhandl 0209e1e
Merge pull request #4480 from handrews/tag-uri-proposal
lornajane 2da6148
respec workflow only on demand
ralfhandl 506fa07
respec.yaml: only run on main
ralfhandl c9f0e3c
Bump @hyperjump/json-schema from 1.11.0 to 1.12.1
dependabot[bot] 748a9d7
Merge pull request #4534 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl 4709f40
Merge pull request #4531 from ralfhandl/main-run-respec-workflow-only…
handrews f8b4feb
Remove mdv, dependency is outdated and it mostly overlaps with
lornajane a163925
Improve markdownlint rules, fix up markdown root files
lornajane 50cfdba
Remove old format script, use markdownlint only and drop prettier
lornajane d301477
Remove outdated dependencies
lornajane 9cc6be0
Correct indentation of empty line
lornajane 79fe003
Remove mdv from workflow
ralfhandl d265168
Update .github/workflows/validate-markdown.yaml
lornajane 856521d
Merge pull request #4 from ralfhandl/improve-markdown-linting
lornajane 7b7d80a
Merge pull request #4515 from lornajane/better-markdown-lint
lornajane 00fc9be
Bump @hyperjump/json-schema from 1.12.1 to 1.13.0
dependabot[bot] a9fd7b1
Bump vitest from 3.1.1 to 3.1.2
dependabot[bot] b58d3e3
Merge pull request #4547 from OAI/dependabot/npm_and_yarn/vitest-3.1.2
ralfhandl b669542
Merge pull request #4546 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl d954b95
Sequential media highlight support
handrews bc8241b
Bump respec from 35.3.0 to 35.3.1
dependabot[bot] 795b892
Add (just barely) multipart support
handrews a3c408a
Tests for multipart highlighting
handrews 69723dd
Merge pull request #4555 from OAI/dependabot/npm_and_yarn/respec-35.3.1
ralfhandl f809d37
Bump @hyperjump/json-schema from 1.13.0 to 1.14.0
dependabot[bot] ee0e1d5
Bump vitest from 3.1.2 to 3.1.3
dependabot[bot] 335931f
Merge pull request #4565 from OAI/dependabot/npm_and_yarn/vitest-3.1.3
ralfhandl c0ec59d
Merge pull request #4563 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl de0f9c2
Merge pull request #4553 from handrews/hljs-seq
handrews 7a9f3d9
Bump respec from 35.3.1 to 35.4.0
dependabot[bot] 11ba483
Bump @hyperjump/json-schema from 1.14.0 to 1.14.1
dependabot[bot] 07e86ea
Merge pull request #4582 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl 5002a5c
Merge pull request #4581 from OAI/dependabot/npm_and_yarn/respec-35.4.0
ralfhandl 8ddd1db
Bump markdownlint-cli2 from 0.17.2 to 0.18.1
dependabot[bot] 038185c
Merge pull request #4580 from OAI/dependabot/npm_and_yarn/markdownlin…
ralfhandl 4711611
Bump yaml from 2.7.1 to 2.8.0
dependabot[bot] bfaba00
Merge pull request #4594 from OAI/dependabot/npm_and_yarn/yaml-2.8.0
handrews File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*.md linguist-detectable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,18 @@ | ||
blank_issues_enabled: true | ||
blank_issues_enabled: false | ||
|
||
contact_links: | ||
- name: OpenAPI Specification | ||
url: https://spec.openapis.org/oas/latest.html | ||
about: View the latest version of the specification | ||
- name: Getting started documentation | ||
url: https://learn.openapis.org | ||
about: Learn about the OpenAPI Specification | ||
- name: OpenAPI Tooling | ||
url: https://tools.openapis.org | ||
about: Open-source and commercial tools for OpenAPI | ||
- name: OpenAPI Initiative Registry | ||
url: https://spec.openapis.org/registry/index.html | ||
about: Registry of formats, extension namespaces etc. | ||
- name: OpenAPI Initiative Slack | ||
- name: Have a question about using OpenAPI? | ||
url: https://communityinviter.com/apps/open-api/openapi | ||
about: Join our online community. | ||
about: Ask us on our Slack! | ||
- name: Have a question about OpenAPI Tooling? | ||
url: https://tools.openapis.org/ | ||
about: Please ask your tooling vendor! | ||
- name: Want to add to our list of OpenAPI Tools? | ||
url: https://tools.openapis.org/ | ||
about: Please take a look at our tooling site's instructions! | ||
- name: Want to suggest more how-to documentation and examples? | ||
url: https://github.com/OAI/learn.openapis.org/issues/new | ||
about: Please open an issue on our learning site! | ||
- name: Want to request a new feature in the specification? | ||
url: https://github.com/OAI/OpenAPI-Specification/discussions/new?category=enhancements | ||
about: Please start a discussion in this repository! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Contribute to the registries at spec.openapis.org/registry | ||
about: Add a new registry entry, or edit an existing one | ||
title: 'Registry: ...' | ||
labels: registries | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Which registry do you want to contribute to** | ||
- [ ] [Alternative Schema Type Registry](https://spec.openapis.org/registry/alternative-schema) | ||
- [ ] [Draft Features Registry](https://spec.openapis.org/registry/draft-feature) | ||
- [ ] [Specification Extension Registry](https://spec.openapis.org/registry/extension) | ||
- [ ] [Format Registry](https://spec.openapis.org/registry/format) | ||
- [ ] [Extension Namespace Registry](https://spec.openapis.org/registry/namespace) | ||
- [ ] [Tag Kind Registry](https://spec.openapis.org/registry/tag-kind) | ||
|
||
**Describe your contribution** | ||
A clear and concise description of what you want to add or change. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Report an error in the specification | ||
about: Create a report to help us improve the specification | ||
title: 'vX.Y: ...' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the error in the specification** | ||
A clear and concise description of | ||
- what the error is, | ||
- which specification versions are affected, | ||
- what you would expect the specification to say instead, and | ||
- a link to the corresponding specification section in the "oldest" affected version. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: check-restricted-files | ||
|
||
# Author: @ralfhandl | ||
# Issue: https://github.com/OAI/OpenAPI-Specification/issues/3432 | ||
|
||
# This workflow fails if restricted files are changed in a pull request | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- 'schemas/**/*.yaml' | ||
- 'versions/*.md' | ||
|
||
jobs: | ||
check-files: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check changed files | ||
shell: bash | ||
run: | | ||
if [[ "${{ github.event.pull_request.head.repo.full_name }}" == "OAI/OpenAPI-Specification" ]] && \ | ||
[[ "${{ github.event.pull_request.base.repo.full_name }}" == "OAI/OpenAPI-Specification" ]]; then | ||
if [[ "${{ github.event.pull_request.head.ref }}" == "main" ]] && \ | ||
[[ "${{ github.event.pull_request.base.ref }}" == "dev" ]]; then | ||
echo Sync from main to dev | ||
exit 0 | ||
fi | ||
|
||
if [[ "${{ github.event.pull_request.head.ref }}" == "dev" ]] && \ | ||
[[ "${{ github.event.pull_request.base.ref }}" =~ ^v[0-9]+\.[0-9]+-dev$ ]]; then | ||
echo Sync from dev to ${{ github.event.pull_request.base.ref }} | ||
exit 0 | ||
fi | ||
|
||
if [[ "${{ github.event.pull_request.head.ref }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+-rel$ ]] && \ | ||
[[ "${{ github.event.pull_request.base.ref }}" == "main" ]]; then | ||
echo Release from ${{ github.event.pull_request.head.ref }} to main | ||
exit 0 | ||
fi | ||
fi | ||
|
||
echo This PR contains changes to files that should not be changed | ||
exit 1 |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: schema-publish | ||
|
||
# author: @ralfhandl | ||
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715 | ||
|
||
# | ||
# This workflow creates a pull request for publishing schema iterations to the gh-pages branch | ||
# | ||
|
||
# run this on push to vX.Y-dev branches or manually | ||
on: | ||
push: | ||
branches: | ||
- 'v[0-9].[0-9]-dev' | ||
paths: | ||
- 'src/schemas/validation/*.yaml' | ||
- 'scripts/schema-publish.sh' | ||
- '.github/workflows/schema-publish.yaml' | ||
workflow_dispatch: {} | ||
|
||
jobs: | ||
publish: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 # checkout main branch | ||
with: | ||
fetch-depth: 0 | ||
|
||
- uses: actions/setup-node@v4 # setup Node.js | ||
with: | ||
node-version: '22.x' | ||
|
||
- name: Install dependencies | ||
run: npm ci | ||
|
||
- uses: actions/checkout@v4 # checkout gh-pages branch | ||
with: | ||
ref: gh-pages | ||
path: deploy | ||
|
||
- name: run main script | ||
run: scripts/schema-publish.sh | ||
|
||
- name: Create Pull Request | ||
uses: peter-evans/create-pull-request@v6 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
branch: ${{ github.ref_name }}-publish-schema-iteration | ||
base: gh-pages | ||
delete-branch: true | ||
path: deploy | ||
labels: Housekeeping,Schema | ||
reviewers: darrelmiller,webron,earth2marsh,webron,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge | ||
title: '${{ github.ref_name }}: publish OpenAPI schema iterations' | ||
commit-message: New OpenAPI schema iterations | ||
signoff: true | ||
body: | | ||
This pull request is automatically generated by GitHub action `schema-publish`. | ||
The `src/schemas/validation/*.yaml` files have changed and JSON files are automatically generated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Address security consideration with GitHub expressions
The workflow uses GitHub event context expressions directly in inline scripts, which might pose a security risk. Consider passing these values through environment variables instead.
Apply similar changes to the other occurrences of GitHub expressions in the script.
🧰 Tools
🪛 actionlint (1.7.4)
20-20: "github.event.pull_request.head.ref" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details
(expression)