Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
701 commits
Select commit Hold shift + click to select a range
30b2c04
Fix missing word
handrews Jul 19, 2025
5d5ea9f
Review feedback.
handrews Jul 19, 2025
678cec6
Further serialization and Unicode guidance.
handrews Jul 19, 2025
747ccc8
Allow Media Type Object re-use
handrews Jul 19, 2025
f88dc0d
Fix typo
handrews Jul 19, 2025
ec1e510
Fix inadvertent plural
handrews Jul 19, 2025
767bdaf
Remove documentation requirement
handrews Jul 19, 2025
459e5bb
Schema updates for #4339
mikekistler Jul 20, 2025
45d844c
Merge pull request #4728 from handrews/mt-e-components
ralfhandl Jul 20, 2025
22e5582
Merge pull request #4747 from handrews/nested-multi
ralfhandl Jul 20, 2025
af2a5a8
Fix grammar
handrews Jul 20, 2025
62d56f0
Support ordered multipart including streaming
handrews Jun 21, 2025
dce24e4
Be more clear about correlations.
handrews Jul 9, 2025
e8b58f5
Review feedback
handrews Jul 17, 2025
ca415e4
More maintainable wording
handrews Jul 17, 2025
0b37bca
New encoding examples
handrews Jun 21, 2025
67e81b9
Better RFC2557 example
handrews Jun 21, 2025
7e8f352
Review feedback.
handrews Jul 17, 2025
674059b
Less snark in the comments
handrews Jul 18, 2025
3a78835
Apply suggestions from PR review
mikekistler Jul 20, 2025
25fe305
Merge pull request #4805 from OAI/mdk/4804-optional-discriminator-schema
handrews Jul 22, 2025
a514ba3
Fix missing component names
handrews Jul 23, 2025
f39ddfd
Fix paragraph order on multipart encoding
handrews Jul 23, 2025
08ee9d6
Merge pull request #4812 from handrews/enc-editorial
handrews Jul 24, 2025
3f57f49
Fix spelling
handrews Jul 24, 2025
cb8baa3
Fix examples (review feedback)
handrews Jul 24, 2025
2940af6
Merge pull request #4799 from handrews/ex-obj-3
lornajane Jul 24, 2025
fb8af87
Merge pull request #4800 from handrews/style-examples-3
handrews Jul 24, 2025
c097759
Merge pull request #4745 from handrews/mixed2
handrews Jul 24, 2025
2600500
maintainable
handrews Jul 24, 2025
2359b8d
More correct from review feedback
handrews Jul 24, 2025
79ec626
Merge pull request #4793 from handrews/schema-inspect
handrews Jul 24, 2025
545cff1
Merge pull request #4802 from handrews/content-examples-3
handrews Jul 24, 2025
774f70c
Merge pull request #4748 from handrews/set-cookie
lornajane Jul 24, 2025
75ac257
Merge pull request #4801 from handrews/param-header-ex-3
miqui Jul 26, 2025
60c4de3
Merge pull request #4711 from handrews/xml-ex
handrews Jul 26, 2025
2b179ff
Fix accidentally removed type
handrews Jul 30, 2025
805084d
Merge pull request #4746 from handrews/mixed-examples
lornajane Jul 31, 2025
f4101ad
Fix deepObject explode default behavior.
handrews Aug 2, 2025
caaa7ab
Fix guidance on headers and RFC6570 percent-encoding
handrews Aug 2, 2025
e9d9764
Fix guidance for RFC6570 and multipart/form-data
handrews Aug 2, 2025
0994210
Reword to placate markdown-lint
handrews Aug 2, 2025
7a602dc
New percent-encoding section.
handrews Aug 2, 2025
a9b21b2
Address quoting and headers more thoroughly.
handrews Aug 3, 2025
6ee805f
Clarify this is about API URLs
handrews Aug 4, 2025
506da3a
Move pct-enc section under Parameter Object
handrews Aug 4, 2025
ded9d94
Merge pull request #4821 from handrews/enc31
handrews Aug 7, 2025
507a3f5
Merge pull request #4820 from handrews/multipct31
handrews Aug 7, 2025
533c6d3
Consolidate example line
handrews Aug 7, 2025
1980fef
Clarifications
handrews Aug 7, 2025
428b75e
Merge pull request #4819 from handrews/header31
handrews Aug 8, 2025
151841c
Explain Param and Header example serialization
handrews Jul 11, 2025
fd8722c
Fix bit from 3.2 that does not apply to 3.1
handrews Aug 11, 2025
786284f
Merge pull request #4826 from handrews/style-examples-31
lornajane Aug 12, 2025
09a6026
Merge pull request #4837 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
4ccdf0d
schema tests: 100% statement coverage
ralfhandl Aug 12, 2025
0c17528
Reusable request bodies need a name
ralfhandl Aug 12, 2025
1018632
Merge pull request #4840 from ralfhandl/3.2-fix-broken-fail-testcases
ralfhandl Aug 12, 2025
43043ce
Merge pull request #4845 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
00d5e85
Merge pull request #4846 from OAI/dev
ralfhandl Aug 12, 2025
831d9cb
Merge pull request #4848 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
657ba5d
Merge pull request #4849 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
a072ea8
Merge pull request #4851 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
87f87f6
Merge pull request #4852 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
fb16c2b
Correct test suite name
ralfhandl Aug 12, 2025
5c70750
Update examples and appendicies for percent-encoding
handrews Aug 3, 2025
429b518
Merge pull request #4825 from handrews/enc-extra31
lornajane Aug 12, 2025
dd3f299
full keyword and line coverage
ralfhandl Aug 12, 2025
e018c4f
Merge pull request #4860 from OAI/dev
oai-spec-publisher[bot] Aug 13, 2025
8cafb94
Merge pull request #4861 from OAI/dev
oai-spec-publisher[bot] Aug 13, 2025
a068e0b
Merge pull request #4853 from ralfhandl/3.2-test-suite-name
ralfhandl Aug 13, 2025
b1bb5d4
Merge pull request #4839 from ralfhandl/3.1-schema-test-keyword-coverage
ralfhandl Aug 13, 2025
9c87c41
Merge remote-tracking branch 'upstream/v3.2-dev' into 3.2-schema-test…
ralfhandl Aug 13, 2025
8ef1e65
Merge pull request #4856 from ralfhandl/3.2-schema-test-keyword-coverage
ralfhandl Aug 13, 2025
adc6cb4
Merge pull request #4818 from handrews/deepo
handrews Aug 13, 2025
d50527b
New percent-encoding section under Parameter Object
handrews Aug 2, 2025
1264d08
Fix guidance for RFC6570 and multipart/form-data
handrews Aug 2, 2025
0fd14b6
Fix guidance on headers and RFC6570 percent-encoding
handrews Aug 2, 2025
56faefa
Fix list formatting (use periods at end)
handrews Jul 11, 2025
f100052
Update examples and appendicies for percent-encoding
handrews Aug 3, 2025
e295dcf
Remove duplicate field in YAML example
handrews Aug 13, 2025
1aedca9
Merge pull request #4864 from handrews/dup-examples
handrews Aug 14, 2025
7338e16
Fix missed update to example from ported changes
handrews Aug 14, 2025
2a86e81
Merge pull request #4863 from handrews/port-pct
lornajane Aug 14, 2025
776ac71
Fix Link Object subsections, improve examples
handrews Aug 14, 2025
13cb466
Merge pull request #4873 from OAI/dev
oai-spec-publisher[bot] Aug 15, 2025
796eb84
Merge pull request #4874 from OAI/dev
oai-spec-publisher[bot] Aug 15, 2025
8e050ef
Remove confusing sentence
ralfhandl Aug 16, 2025
eddf15a
Use same name as in RFC7159
ralfhandl Aug 16, 2025
94b16b2
Fix stray extra paren
handrews Aug 16, 2025
1f15802
Merge pull request #4875 from ralfhandl/3.1-xml-null-example-confusin…
ralfhandl Aug 17, 2025
f6b2777
Merge pull request #4877 from ralfhandl/3.1-runtime-expression-abnf
ralfhandl Aug 17, 2025
b561d4d
Sync Appendix E from 3.2
ralfhandl Aug 17, 2025
ef3b20b
Merge pull request #4868 from handrews/link-examples-31
lornajane Aug 17, 2025
912a96e
Convention is to use lowercase
ralfhandl Aug 17, 2025
2dadb57
Typos and editorial changes
ralfhandl Aug 16, 2025
26c934e
Merge pull request #4882 from ralfhandl/3.2-code-block-language-lower…
handrews Aug 17, 2025
9750a7e
Merge pull request #4885 from OAI/dev
oai-spec-publisher[bot] Aug 18, 2025
cb30750
Merge pull request #4886 from OAI/dev
oai-spec-publisher[bot] Aug 18, 2025
07bb159
Merge pull request #4890 from OAI/dev
oai-spec-publisher[bot] Aug 20, 2025
bc35e9c
Merge pull request #4891 from OAI/dev
oai-spec-publisher[bot] Aug 20, 2025
bf0d54a
Merge pull request #4876 from ralfhandl/3.2-typos
ralfhandl Aug 20, 2025
d4c6a33
Merge pull request #4897 from OAI/dev
oai-spec-publisher[bot] Aug 21, 2025
0193c67
Merge pull request #4898 from OAI/dev
oai-spec-publisher[bot] Aug 21, 2025
d44b34f
Encoding style default behavior
handrews Aug 18, 2025
0e8e7e3
Update Set-Cookie example for recent changes
handrews Aug 21, 2025
0a73308
Fix allowReserved
handrews Aug 21, 2025
49d1c51
Merge pull request #4900 from handrews/allow-reserved
ralfhandl Aug 21, 2025
b78f66a
Add style: cookie, explain pct-encoding
handrews Aug 21, 2025
a83ae2a
Merge pull request #4899 from handrews/enc-style-defaults
lornajane Aug 21, 2025
ddf91fb
checkpoint
handrews Aug 21, 2025
f02e752
whatwg
handrews Aug 21, 2025
d62df60
Apply suggestions from code review
handrews Aug 21, 2025
125c34c
Apply suggestions from code review
handrews Aug 21, 2025
ee1021a
Fix review suggestion that broke build.
handrews Aug 21, 2025
8ef326d
fix: fix type for Header.schema fixed field
char0n Aug 21, 2025
9e03421
Review feedback.
handrews Aug 21, 2025
585321d
Fix error in example.
handrews Aug 21, 2025
34cd332
grammar fix
handrews Aug 22, 2025
f0b3fa8
grammar
handrews Aug 22, 2025
e4c0230
Merge pull request #4902 from handrews/cookie32-noschema
lornajane Aug 23, 2025
d592765
Encoding style default behavior
handrews Aug 18, 2025
10633c5
Merge pull request #4906 from swaggerexpert/char0n/schema-reference-a…
miqui Aug 24, 2025
d17c44d
Merge pull request #4903 from handrews/set-cookie-example
ralfhandl Aug 25, 2025
8cd87cb
Review feedback.
handrews Aug 25, 2025
3009102
Merge pull request #4907 from handrews/enc-style-defaults-31
handrews Aug 26, 2025
b3b4233
Merge pull request #4905 from handrews/urlencoded
handrews Aug 26, 2025
fc77a73
Reorganize early (and other) sections
handrews Aug 25, 2025
fb45114
Fix heading levels post-section reorganization.
handrews Aug 25, 2025
1328ee8
Parameter Object with in:querystring can't have content
ralfhandl Aug 28, 2025
3f1df3f
OAD schema 'parameter object' + in: querystring drop `not`+`required`…
notEthan Aug 28, 2025
904873e
Merge pull request #4909 from notEthan/oad-schema-querystring-forbid-…
handrews Aug 29, 2025
690560b
Merge pull request #4908 from handrews/sections
handrews Aug 31, 2025
14e5667
Merge Versions and Deprecation sections
handrews Aug 22, 2025
2c56b00
Remove outdated Server Object crossref
handrews Aug 22, 2025
445d76f
Rename "Schema" to "Objects and Fields"
handrews Aug 22, 2025
f80a4cd
Add links to Introduction.
handrews Aug 27, 2025
2b4c061
Remove counter-intuitive section name hack.
handrews Aug 28, 2025
5a17b01
Improve Link Object Examples
handrews Aug 14, 2025
cc1d673
Port review feedback from v3.1-dev
handrews Aug 27, 2025
61177cb
Fix outdated RFC ref ported from 3.1
handrews Aug 28, 2025
de84701
Fix the moved Media Types section
handrews Aug 31, 2025
8b999d1
Merge pull request #4916 from handrews/mts
handrews Sep 1, 2025
c7a7629
Merge pull request #4879 from ralfhandl/3.1-sync-appendix-E-from-3.2
ralfhandl Sep 2, 2025
c37475c
Merge pull request #4915 from handrews/from-31
ralfhandl Sep 2, 2025
c3f5b96
Merge pull request #4913 from handrews/misc-reorg
lornajane Sep 3, 2025
f505d31
Merge pull request #4921 from OAI/dev
oai-spec-publisher[bot] Sep 4, 2025
130f076
Merge pull request #4922 from OAI/dev
oai-spec-publisher[bot] Sep 4, 2025
dc5dad6
"example" and "examples" cannot appear together
karenetheridge Aug 31, 2025
2933fe9
Merge pull request #4912 from karenetheridge/ether/v3.2-example-examp…
ralfhandl Sep 5, 2025
f34083a
"example" and "examples" cannot appear together
karenetheridge Aug 31, 2025
c33e5ba
Merge pull request #4917 from karenetheridge/v3.1-example-examples-mu…
handrews Sep 6, 2025
e857e6e
Refactor OpenAPI Description Structure sections
handrews Aug 28, 2025
9e49f96
Streamline OpenAPI Description Structure post-moves
handrews Aug 28, 2025
4c6fcd2
Fix spelling
handrews Sep 8, 2025
33c6719
Fix openapi field's description of version field
handrews Sep 8, 2025
b1eedf2
Wording feedback
handrews Sep 8, 2025
ae1b5ea
Merge pull request #4932 from OAI/dev
oai-spec-publisher[bot] Sep 8, 2025
3da8f96
Merge pull request #4934 from OAI/dev
oai-spec-publisher[bot] Sep 8, 2025
0be8310
Merge pull request #4935 from OAI/dev
oai-spec-publisher[bot] Sep 8, 2025
28922ae
Merge pull request #4936 from OAI/dev
oai-spec-publisher[bot] Sep 8, 2025
c2fbd3f
Fix reference to info.version
handrews Sep 9, 2025
1e94ea4
Merge pull request #4927 from handrews/oad2
lornajane Sep 9, 2025
c012298
Merge pull request #4938 from handrews/version
lornajane Sep 9, 2025
7926ee2
fix broken link
ralfhandl Sep 12, 2025
319871b
Consistent dashing for case sensitive
ralfhandl Sep 12, 2025
07f11cb
Typo
ralfhandl Sep 12, 2025
c1076ff
Consistent dashes in URI reference
ralfhandl Sep 12, 2025
31eef03
Consistent use of "JSON Pointer"
ralfhandl Sep 12, 2025
27432d7
Remove unnecessary sentence
ralfhandl Sep 12, 2025
af2c85d
Consistent formatting
ralfhandl Sep 12, 2025
46366ec
Add informative reference to JSONPath
ralfhandl Sep 12, 2025
628f1e8
Informative reference to HTML Standard
ralfhandl Sep 12, 2025
7cc727a
Misspelled anchor
ralfhandl Sep 12, 2025
7244caa
Use current section header as link text
ralfhandl Sep 12, 2025
5d5d9a5
Remove irritating comma
ralfhandl Sep 12, 2025
942cf8c
base uri: reference RFC3986
ralfhandl Sep 12, 2025
a70261b
Merge pull request #4943 from ralfhandl/3.2-4.1.2.2-typo
ralfhandl Sep 12, 2025
4fd4f34
Merge pull request #4945 from ralfhandl/3.2-uri-reference
ralfhandl Sep 12, 2025
90d6f99
Merge pull request #4949 from ralfhandl/3.2-jsonpath-reference
lornajane Sep 14, 2025
9a8cdb6
Merge pull request #4950 from ralfhandl/3.2-reference-html5
lornajane Sep 14, 2025
69c0b31
Merge pull request #4951 from ralfhandl/3.2-encoding-usage-broken-link
lornajane Sep 14, 2025
3781a47
Merge pull request #4952 from ralfhandl/3.2-sse-streams-section-refer…
lornajane Sep 14, 2025
b06ccfc
Merge pull request #4953 from ralfhandl/3.2-example-object-irritating…
lornajane Sep 14, 2025
d3abb59
Merge pull request #4954 from ralfhandl/3.2-rfc3886-references
lornajane Sep 14, 2025
916e5c6
Merge pull request #4948 from ralfhandl/3.2-style-examples-formatting
lornajane Sep 14, 2025
d9a291c
Merge pull request #4947 from ralfhandl/3.2-serialization-remove-unne…
lornajane Sep 14, 2025
cd64743
Merge pull request #4946 from ralfhandl/3.2-json-pointer
lornajane Sep 14, 2025
38c789f
Merge pull request #4941 from ralfhandl/3.2-broken-implicit-connectio…
lornajane Sep 14, 2025
57c9da5
Switch to dashed variant everywhere
ralfhandl Sep 15, 2025
4e1877b
pull out subschemas that do not need to be in an allOf
karenetheridge Aug 31, 2025
2773541
remove redundant $ref: examples are allowed in "content" now too
karenetheridge Sep 5, 2025
3c675a8
use non-capturing parentheses everywhere
karenetheridge Sep 6, 2025
f1edd25
use non-capturing parentheses everywhere
karenetheridge Sep 15, 2025
9ac8910
remove redundant "requires"
karenetheridge Sep 12, 2025
b5c43e5
case sensitivity (noun) without dashes
ralfhandl Sep 15, 2025
c4673bc
whitespace
karenetheridge Sep 12, 2025
c602ca6
remove confusing use of json within yaml
karenetheridge Sep 12, 2025
d4fec14
remove redundant "requires"
karenetheridge Sep 15, 2025
c8565c7
whitespace
karenetheridge Sep 15, 2025
56aafd8
remove confusing use of json within yaml
karenetheridge Sep 15, 2025
72de87b
style and allowReserved defaults are only in effect when any of style…
karenetheridge Sep 15, 2025
33907e0
clarify other prohibited combinations of query+querystring
karenetheridge Sep 15, 2025
a3082cb
be explicit that this table shows ALL valid combinations
karenetheridge Sep 15, 2025
8290d55
Markdown improvements for the Style Values table
karenetheridge Sep 15, 2025
9adf475
remove json markup in yaml examples of literal values
karenetheridge Sep 15, 2025
14528c9
query and querystring are mutually exclusive; disallow more than one …
karenetheridge Aug 31, 2025
21010ce
allow the use of in: cookie, style: cookie
karenetheridge Sep 12, 2025
2463bd0
style and allowReserved defaults are only in effect when any of style…
karenetheridge Sep 13, 2025
bea55aa
Merge pull request #4942 from ralfhandl/3.2-case-sensitive
ralfhandl Sep 16, 2025
cdb1834
Merge pull request #4963 from OAI/dev
oai-spec-publisher[bot] Sep 16, 2025
153c4ca
Merge pull request #4964 from OAI/dev
oai-spec-publisher[bot] Sep 16, 2025
259ea07
Merge branch 'v3.2-dev' into ether/v3.2-spec-markup
ralfhandl Sep 16, 2025
5f38d1d
Merge pull request #4959 from karenetheridge/ether/v3.2-spec-markup
ralfhandl Sep 16, 2025
466b723
fix character terminology in ABNF comments
karenetheridge Sep 16, 2025
2774312
these two xml properties are now deprecated; harmonize spec language
karenetheridge Sep 18, 2025
ec81bb8
the "example" keyword is now deprecated
karenetheridge Sep 18, 2025
c2b1114
"propertyName" is no longer required
karenetheridge Sep 18, 2025
cbc7821
Merge pull request #4966 from karenetheridge/ether/xml-deprecations
lornajane Sep 18, 2025
16b60f8
Merge pull request #4965 from karenetheridge/ether/v3.2-ABNF-amendments
mikekistler Sep 18, 2025
1919217
Merge pull request #4957 from karenetheridge/ether/v3.2-schema-remnants
lornajane Sep 18, 2025
24b3d5b
Merge pull request #4958 from karenetheridge/v3.1-dev
lornajane Sep 18, 2025
91bc669
Adjust branch for 3.1 release
lornajane Sep 18, 2025
2c162bf
Adjust the branch for release of 3.2
lornajane Sep 18, 2025
de2325a
Set the publish date
lornajane Sep 19, 2025
36af853
Set the publication date
lornajane Sep 19, 2025
8260336
Merge pull request #4969 from OAI/v3.1.2-rel
lornajane Sep 19, 2025
99710bc
Merge pull request #4970 from OAI/v3.2.0-rel
lornajane Sep 19, 2025
f371890
Repair broken link in 3.2.0.md
ralfhandl Sep 20, 2025
a36ae6b
More broken links
ralfhandl Sep 24, 2025
815732d
Merge pull request #4979 from OAI/ralfhandl-patch-5
lornajane Sep 28, 2025
3f80cae
main: adjust reviewers in respec workflow
ralfhandl Oct 1, 2025
5f46ea3
Merge pull request #5002 from OAI/ralfhandl-patch-1
lornajane Oct 1, 2025
63d46be
sync main -> dev -> vX.Y-dev via sync branches
ralfhandl Oct 5, 2025
e337060
Replace release date placeholder with current date
ralfhandl Oct 6, 2025
eae7926
Add linkspector hyperlink checker
ralfhandl Oct 6, 2025
0a45a47
npm audit fix
ralfhandl Oct 6, 2025
e403595
Merge pull request #5012 from ralfhandl/main-linkspector
ralfhandl Oct 6, 2025
0efdc65
Merge pull request #5011 from ralfhandl/main-adjust-release-history-date
ralfhandl Oct 6, 2025
f8dbf9b
create jekyll lander if necessary
ralfhandl Oct 7, 2025
ce213cd
validate-markdown,yaml: use Linkspector action
ralfhandl Oct 7, 2025
51067fa
Merge pull request #5025 from ralfhandl/main-fix-puppeteer-problem
ralfhandl Oct 7, 2025
fa435ac
Merge branch 'main' into main-schema-publish-create-jekyll-lander
ralfhandl Oct 7, 2025
710094e
Merge pull request #5024 from ralfhandl/main-schema-publish-create-je…
ralfhandl Oct 7, 2025
ca75881
docs: Clarified the status of version 3.2 and added information about…
baywet Oct 9, 2025
84cae08
docs: Add 3.3.x spec and schemas reference to PR template
baywet Oct 9, 2025
1bfc015
Merge pull request #5029 from baywet/patch-2
karenetheridge Oct 9, 2025
26c18ac
Merge pull request #5028 from baywet/patch-1
ralfhandl Oct 9, 2025
c22f7da
Merge pull request #5010 from OAI/main-sync-workflows
ralfhandl Oct 11, 2025
a401932
Restored src/* and tests/*
github-actions[bot] Oct 11, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ present on the main branch, only on the development branches).

* 3.1.x spec and schemas: v3.1-dev branch
* 3.2.x spec and schemas: v3.2-dev branch
* 3.3.x spec and schemas: v3.3-dev branch
* registry templates: gh-pages branch, registry/...
* registry contents: gh-pages branch, registries/...
* process documentation and build infrastructure: main
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/respec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
delete-branch: true
path: deploy
labels: Housekeeping
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
reviewers: earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
title: Update ReSpec-rendered specification versions
commit-message: Update ReSpec-rendered specification versions
signoff: true
Expand Down
28 changes: 21 additions & 7 deletions .github/workflows/sync-dev-to-vX.Y-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
push:
branches:
- dev
workflow_dispatch: {}

jobs:
sync-branches:
Expand All @@ -22,36 +23,49 @@ jobs:
with:
app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}

- name: Checkout repository
uses: actions/checkout@v5
with:
fetch-depth: 0
token: ${{ steps.generate-token.outputs.token }}

- name: Create pull requests
id: pull_requests
shell: bash
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

DEV_BRANCHES=$(git branch -r --list origin/v?.?-dev)
for DEV_BRANCH in $DEV_BRANCHES; do
BASE=${DEV_BRANCH:7}
EXISTS=$(gh pr list --base $BASE --head $HEAD \
SYNC="$BASE-sync-with-$HEAD"

git checkout -b $SYNC origin/$SYNC || git checkout -b $SYNC origin/$BASE
git merge origin/$HEAD -m "Merge $HEAD into $SYNC"
git checkout origin/$BASE src/*
git checkout origin/$BASE tests/*
git commit -m "Restored src/* and tests/*" || echo ""
git push -u origin $SYNC

EXISTS=$(gh pr list --base $BASE --head $SYNC \
--json number --jq '.[] | .number')
if [ ! -z "$EXISTS" ]; then
echo "PR #$EXISTS already wants to merge $HEAD into $BASE"
echo "PR #$EXISTS already wants to merge $SYNC into $BASE"
continue
fi

PR=$(gh pr create --base $BASE --head $HEAD \
PR=$(gh pr create --base $BASE --head $SYNC \
--label "Housekeeping" \
--title "$BASE: update from $HEAD" \
--body "Merge \`$HEAD\` into \`$BASE\`.")
--title "$BASE: sync with $HEAD" \
--body "Merge relevant changes from \`$HEAD\` into \`$BASE\`.")
echo ""
echo "PR to sync $DEV_BRANCH: $PR"
sleep 10 # allow status checks to be triggered

gh pr checks $PR --watch --required || continue
gh pr merge $PR --merge --admin
# gh pr merge $PR --merge --admin
done
env:
GH_TOKEN: ${{ steps.generate-token.outputs.token }}
Expand Down
25 changes: 20 additions & 5 deletions .github/workflows/sync-main-to-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
push:
branches:
- main
workflow_dispatch: {}

jobs:
sync-branch:
Expand All @@ -25,22 +26,36 @@ jobs:

- name: Checkout repository
uses: actions/checkout@v5
with:
fetch-depth: 0
token: ${{ steps.generate-token.outputs.token }}

- name: Create pull request
id: pull_request
shell: bash
run: |
EXISTS=$(gh pr list --base $BASE --head $HEAD \
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
SYNC="$BASE-sync-with-$HEAD"

git checkout -b $SYNC origin/$SYNC || git checkout -b $SYNC origin/$BASE
git merge origin/$HEAD -m "Merge $HEAD into $SYNC"
git checkout origin/$BASE src/*
git checkout origin/$BASE tests/*
git commit -m "Restored src/* and tests/*" || echo ""
git push -u origin $SYNC

EXISTS=$(gh pr list --base $BASE --head $SYNC \
--json number --jq '.[] | .number')
if [ ! -z "$EXISTS" ]; then
echo "PR #$EXISTS already wants to merge $HEAD into $BASE"
echo "PR #$EXISTS already wants to merge $SYNC into $BASE"
exit 0
fi

gh pr create --base $BASE --head $HEAD \
gh pr create --base $BASE --head $SYNC \
--label "Housekeeping" \
--title "$BASE: update from $HEAD" \
--body "Merge \`$HEAD\` into \`$BASE\`."
--title "$BASE: sync with $HEAD" \
--body "Merge relevant changes from \`$HEAD\` into \`$BASE\`."
env:
GH_TOKEN: ${{ steps.generate-token.outputs.token }}
HEAD: main
Expand Down
27 changes: 15 additions & 12 deletions .github/workflows/validate-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,24 @@ on: [push, pull_request]

jobs:
lint:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v5 # checkout repo content
with:
fetch-depth: 0
- uses: actions/checkout@v5 # checkout repo content

- uses: actions/setup-node@v5 # setup Node.js
with:
node-version: "20.x"

- uses: actions/setup-node@v5 # setup Node.js
with:
node-version: '20.x'
- name: Lint work-in-progress spec
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md

- name: Lint work-in-progress spec
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md
- name: Lint other files
run: npx --yes markdownlint-cli2 *.md

- name: Lint other files
run: npx --yes markdownlint-cli2 *.md
- name: Check links in markdown files
uses: umbrelladocs/action-linkspector@v1
with:
reporter: github-check
fail_level: any
filter_mode: nofilter
15 changes: 15 additions & 0 deletions .linkspector.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
files:
- src/oas.md
- CONTRIBUTING.md
- EDITORS.md
# - GOVERNANCE.md
- IMPLEMENTATIONS.md
- MAINTAINERS.md
- README.md
- SECURITY_CONSIDERATIONS.md
- SPECIAL_INTEREST_GROUPS.md
- style-guide.md
- TOB.md
ignorePatterns:
- pattern: 'clientdomain.com'
- pattern: 'example.org'
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Exceptions may be made when links to external URLs have been changed by a 3rd pa

Published versions of the specification are in the `versions/` folder.
The under-development versions of the specification are in the file `src/oas.md` on the appropriately-versioned branch.
For example, work on the next release for 3.2 is on `v3.2-dev` in the file `src/oas.md`.
For example, work on the next patch release for 3.2 is on `v3.2-dev` in the file `src/oas.md`, and work on the next minor release with additional features for 3.3 is on `v3.3-dev`.

The [spec site](https://spec.openapis.org) is the source of truth for the OpenAPI specification as it contains all the citations and author credits (the markdown in this repository was previously the authoritative version until 2024).

Expand All @@ -24,7 +24,8 @@ The current active specification releases are:
| Version | Branch | Notes |
| ------- | ------ | ----- |
| 3.1.2 | `v3.1-dev` | active patch release line |
| 3.2.0 | `v3.2-dev` | minor release in development |
| 3.2.0 | `v3.2-dev` | active patch release line |
| 3.3.0 | `v3.3-dev` | minor release in development |
| 4.0.0 | [OAI/sig-moonwalk](https://github.com/OAI/sig-moonwalk) | [discussions only](https://github.com/OAI/sig-moonwalk/discussions) |


Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
The current process for developing the OpenAPI Specification is described in
the [Contributing Guidelines](CONTRIBUTING.md).

Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](https://www.openapis.org/participate/how-to-contribute/governance#TDC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](MAINTAINERS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.

The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the entire OpenAPI [technical meeting calendar](https://calendar.google.com/calendar/u/0/[email protected]) online.

Expand Down
Loading
Loading