Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
189 commits
Select commit Hold shift + click to select a range
67b94d9
Start next patch - bump version to 3.1.2
handrews Oct 24, 2024
f39b788
Validate src/oas.md
ralfhandl Nov 13, 2024
866e92f
Merge pull request #4196 from ralfhandl/v3.1-validate-oas.md
handrews Nov 13, 2024
d48ff11
Merge branch 'dev' into v3.1-dev-update-from-dev
ralfhandl Nov 21, 2024
5a0a0e8
Merge pull request #4219 from ralfhandl/v3.1-dev-update-from-dev
handrews Nov 21, 2024
21b5bcf
Editorial change: Link Object points to Operation Object
char0n Dec 17, 2024
c15db13
Merge pull request #4260 from char0n/char0n/link-operation
ralfhandl Dec 18, 2024
fe5b234
Editorial change: Include Header Object into 'Working With Examples' …
char0n Dec 18, 2024
7cd34d2
Editorial change: fix typo in Link Object description
char0n Dec 18, 2024
1b65003
Update src/oas.md
char0n Dec 18, 2024
8cc59b6
Update src/oas.md
char0n Dec 18, 2024
150e125
Update src/oas.md
char0n Dec 18, 2024
377e124
Update src/oas.md
char0n Dec 18, 2024
6eb487b
Editorial change: add Header Object to Generating and Validating URIs…
char0n Dec 18, 2024
f896bb7
Update src/oas.md
char0n Dec 18, 2024
2dcd87d
Merge pull request #4266 from char0n/char0n/refereced-typo
ralfhandl Dec 19, 2024
8598f2f
Merge pull request #4267 from char0n/char0n/generating-and-validating…
ralfhandl Dec 19, 2024
4e4a292
Merge pull request #4265 from char0n/char0n/add-header-into-working-w…
handrews Dec 19, 2024
e738e4a
Introduce constraints for Server Object url fixed field
char0n Dec 19, 2024
8b91379
Update src/oas.md
char0n Dec 20, 2024
ccf329f
Update src/oas.md
char0n Dec 20, 2024
4fc2fdb
Merge pull request #4272 from swaggerexpert/char0n/server-url-constra…
ralfhandl Jan 3, 2025
1e0fd70
Editorial change: fix anchor to Components.securitySchemes
char0n Dec 27, 2024
dbba0ba
Fix copy-paste "format: binary" error
handrews Jan 9, 2025
f48940c
Typo
ralfhandl Jan 10, 2025
0178e80
Merge pull request #4282 from swaggerexpert/char0n/fix-components-sec…
ralfhandl Jan 10, 2025
9291879
Merge pull request #4294 from handrews/copy-paste
ralfhandl Jan 10, 2025
5b0a31a
Feedback from mkistler about contentEncoding
handrews Jan 15, 2025
628e971
Apply suggestions from code review
ralfhandl Jan 16, 2025
a922855
Merge pull request #4301 from handrews/copy-paste-2
ralfhandl Jan 17, 2025
39c3571
Adjust uri to uri-reference for security schema fixed fields
markrzen Feb 4, 2025
8a686f6
as decided in TDC call on 2025-01-23
ralfhandl Feb 5, 2025
17ab8d6
Update CONTRIBUTING.md
ralfhandl Feb 5, 2025
5d505db
Update CONTRIBUTING.md
ralfhandl Feb 6, 2025
b7163c1
Reactor all but xml.namespace from uri to uri-reference
markrzen Feb 6, 2025
c2c9aaf
Update CONTRIBUTING.md
ralfhandl Feb 6, 2025
97e7b3d
Update CONTRIBUTING.md
ralfhandl Feb 7, 2025
d22d504
Merge pull request #4328 from markrzen/patch-2
ralfhandl Feb 13, 2025
4dc85ae
Update src schema with changes from #4328
ralfhandl Feb 13, 2025
ed39e4a
Merge pull request #4331 from ralfhandl/v3.1-field-names-and-values-i…
ralfhandl Feb 16, 2025
0cb336b
Editorial change: fix typo in runtime expression CHAR non-terminal
char0n Feb 17, 2025
f0fad47
Merge pull request #4368 from swaggerexpert/char0n/runtime-expressions
lornajane Feb 20, 2025
9fd4e2e
Merge pull request #4360 from ralfhandl/v3.1-uri-reference
lornajane Feb 20, 2025
9bcc030
Delete schema.yaml
ralfhandl Mar 6, 2025
3b45fd4
Update CONTRIBUTING.md
ralfhandl Mar 6, 2025
ca0b2f7
Revert "Update CONTRIBUTING.md"
ralfhandl Mar 6, 2025
c609a46
Revert "Update CONTRIBUTING.md"
ralfhandl Mar 6, 2025
67ac64d
Revert "Update CONTRIBUTING.md"
ralfhandl Mar 6, 2025
fb2bc8e
Revert "Update CONTRIBUTING.md"
ralfhandl Mar 6, 2025
86f3f67
Revert "Update CONTRIBUTING.md"
ralfhandl Mar 6, 2025
c4cf1f2
Merge pull request #4417 from OAI/v3.1-dev-resolve-conflicts
handrews Mar 13, 2025
4189639
Merge pull request #4396 from OAI/dev
handrews Mar 13, 2025
5172ca5
Merge pull request #4431 from OAI/dev
ralfhandl Mar 13, 2025
2b4dbae
Merge pull request #4440 from OAI/dev
ralfhandl Mar 14, 2025
875f73d
Merge pull request #4445 from OAI/dev
ralfhandl Mar 17, 2025
57d14eb
Merge pull request #4450 from OAI/dev
ralfhandl Mar 18, 2025
97982a5
Merge pull request #4460 from OAI/dev
ralfhandl Mar 19, 2025
52c89a3
Fixes #4463
ralfhandl Mar 19, 2025
6f26e0b
Schema coverage: 100%
ralfhandl Mar 18, 2025
8e11b5e
Merge pull request #4475 from OAI/dev
ralfhandl Mar 20, 2025
7f80945
Merge pull request #4477 from OAI/dev
ralfhandl Mar 20, 2025
3d9995c
Merge pull request #4484 from OAI/dev
ralfhandl Mar 21, 2025
4e07303
Merge pull request #4465 from ralfhandl/3.1-fix-link-object-schema
miqui Mar 22, 2025
fd1cd3b
Merge pull request #4496 from OAI/dev
ralfhandl Mar 24, 2025
ae0464c
Merge remote-tracking branch 'upstream/v3.1-dev' into 3.1-schema-test…
ralfhandl Mar 24, 2025
6f5e6c4
Add test case for "body"/"server" bug fix
ralfhandl Mar 27, 2025
5fb815d
Discrimator -> Discriminator
handrews Mar 27, 2025
6dc2065
Merge pull request #4507 from handrews/spelling
lornajane Mar 27, 2025
f2b85b0
Merge pull request #4510 from OAI/dev
ralfhandl Mar 28, 2025
13d3356
Merge pull request #4520 from OAI/dev
handrews Mar 30, 2025
177d639
Merge pull request #4525 from OAI/dev
handrews Mar 31, 2025
e085227
Merge pull request #4468 from ralfhandl/3.1-schema-test-coverage
handrews Apr 10, 2025
f132969
Merge pull request #4536 from OAI/dev
handrews Apr 10, 2025
7b03a72
Merge pull request #4557 from OAI/dev
ralfhandl Apr 29, 2025
cc4cdbe
Merge pull request #4571 from OAI/dev
handrews May 8, 2025
80f5126
Merge pull request #4586 from OAI/dev
handrews May 15, 2025
385f279
Root XML element name comes from component name
handrews May 13, 2025
58c4f06
Align wording with components rather than "root"
handrews May 15, 2025
f8a7ad4
Tidy up some suspect formatting
lornajane May 16, 2025
4ff5c2e
Merge pull request #4603 from OAI/dev
handrews May 16, 2025
8f03154
Provide guidance on null in XML.
handrews May 18, 2025
70274dc
Clarify that Request Body Objects need a body
handrews May 18, 2025
32f5c3c
Merge pull request #4601 from lornajane/tidy-formatting
ralfhandl May 19, 2025
21d0a85
Punctuation per style guide
handrews May 19, 2025
a200ab6
Fix capitalization
handrews May 19, 2025
b376a1d
Merge pull request #4614 from handrews/req-content
handrews May 20, 2025
6aab818
Merge pull request #4619 from OAI/dev
handrews May 20, 2025
0e5c817
Merge pull request #4576 from handrews/xml-root-312
lornajane May 21, 2025
b3dd05f
Merge pull request #4612 from handrews/xml-null-312
lornajane May 22, 2025
1c0920c
Merge pull request #4628 from OAI/dev
handrews May 27, 2025
9c02ae3
Merge pull request #4636 from OAI/dev
handrews May 28, 2025
005bd94
Merge pull request #4640 from OAI/dev
handrews May 29, 2025
9393282
Merge pull request #4653 from OAI/dev
handrews Jun 4, 2025
f7684f3
Merge pull request #4669 from OAI/dev
handrews Jun 9, 2025
51e7b8e
Merge pull request #4678 from OAI/dev
handrews Jun 10, 2025
1ad1a2f
Merge pull request #4684 from OAI/dev
ralfhandl Jun 11, 2025
236b5f3
Merge pull request #4691 from OAI/dev
handrews Jun 11, 2025
21751b1
Merge pull request #4696 from OAI/dev
handrews Jun 12, 2025
f6a083c
Use matching jsonSchemaDialect
handrews Jun 12, 2025
6215119
Add XML Object schema tests
handrews Jun 13, 2025
cbc870f
Use externalDocs in a schema test object
handrews Jun 13, 2025
d287f99
Cover discriminator with schema test cases
handrews Jun 13, 2025
aa017cb
Merge pull request #4703 from handrews/test-31
handrews Jun 13, 2025
d9c5e49
Merge pull request #4705 from OAI/dev
ralfhandl Jun 13, 2025
0af22a6
Merge pull request #4716 from OAI/dev
ralfhandl Jun 14, 2025
7d56471
Merge pull request #4722 from OAI/dev
ralfhandl Jun 14, 2025
c714d57
Merge pull request #4732 from OAI/dev
handrews Jun 16, 2025
2c83aa5
Merge pull request #4738 from OAI/dev
ralfhandl Jun 18, 2025
7bf5065
Merge pull request #4754 from OAI/dev
handrews Jul 3, 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
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
43043ce
Merge pull request #4845 from OAI/dev
oai-spec-publisher[bot] Aug 12, 2025
831d9cb
Merge pull request #4848 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
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
e018c4f
Merge pull request #4860 from OAI/dev
oai-spec-publisher[bot] Aug 13, 2025
b1bb5d4
Merge pull request #4839 from ralfhandl/3.1-schema-test-keyword-coverage
ralfhandl Aug 13, 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
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
9750a7e
Merge pull request #4885 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
d4c6a33
Merge pull request #4897 from OAI/dev
oai-spec-publisher[bot] Aug 21, 2025
8ef326d
fix: fix type for Header.schema fixed field
char0n Aug 21, 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
8cd87cb
Review feedback.
handrews Aug 25, 2025
3009102
Merge pull request #4907 from handrews/enc-style-defaults-31
handrews Aug 26, 2025
c7a7629
Merge pull request #4879 from ralfhandl/3.1-sync-appendix-E-from-3.2
ralfhandl Sep 2, 2025
f505d31
Merge pull request #4921 from OAI/dev
oai-spec-publisher[bot] Sep 4, 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
ae1b5ea
Merge pull request #4932 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
c2fbd3f
Fix reference to info.version
handrews Sep 9, 2025
c012298
Merge pull request #4938 from handrews/version
lornajane Sep 9, 2025
f1edd25
use non-capturing parentheses everywhere
karenetheridge Sep 15, 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
cdb1834
Merge pull request #4963 from OAI/dev
oai-spec-publisher[bot] Sep 16, 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
01fed7d
sync dev with main via sync branch
ralfhandl Oct 4, 2025
82eca8b
Restored src/* and tests/*
cincrement Oct 4, 2025
21c1201
Merge pull request #65 from ralfhandl/dev-sync-with-main
ralfhandl Oct 4, 2025
f60b80a
sync dev with main via sync branch
ralfhandl Oct 4, 2025
ea8eb91
Update sync-dev-to-vX.Y-dev.yaml
ralfhandl Oct 4, 2025
d790eb0
Merge main into dev-sync-with-main
cincrement Oct 4, 2025
95d1808
Merge pull request #69 from ralfhandl/dev-sync-with-main
ralfhandl Oct 4, 2025
55336a3
Update sync-dev-to-vX.Y-dev.yaml
ralfhandl Oct 4, 2025
d1adae6
Merge main into dev-sync-with-main
cincrement Oct 4, 2025
9679a47
Merge pull request #72 from ralfhandl/dev-sync-with-main
ralfhandl Oct 4, 2025
1dd2996
Bot username and email
ralfhandl Oct 5, 2025
062ef98
Merge main into dev-sync-with-main
github-actions[bot] Oct 5, 2025
d8af546
Merge pull request #74 from ralfhandl/dev-sync-with-main
ralfhandl Oct 5, 2025
ee79aa1
Restored src/* and tests/*
github-actions[bot] Oct 5, 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
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
12 changes: 6 additions & 6 deletions src/oas.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ In addition to the required fields, at least one of the `components`, `paths`, o
| Field Name | Type | Description |
| ---- | :----: | ---- |
| <a name="oas-version"></a>openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions-and-deprecation) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the [`info.version`](#info-version) string, which describes the OpenAPI document's version. |
| <a name="oas-self"></a>$self | `string` | This string MUST be in the form of a URI reference as defined by [[RFC3986]] [Section 4.1](https://www.rfc-editor.org/rfc/rfc3986#section-4.1). The `$self` field provides the self-assigned URI of this document, which also serves as its base URI in accordance with [[RFC3986]] [Section 5.1.1](https://www.rfc-editor.org/rfc/rfc3986#section-5.1.1). Implementations MUST support identifying the targets of [API description URIs](#relative-references-in-api-description-uris) using the URI defined by this field when it is present. See [Establishing the Base URI](#establishing-the-base-uri) for the base URI behavior when `$self` is absent or relative, and see [Appendix F]((#appendix-f-examples-of-base-uri-determination-and-reference-resolution)) for examples of using `$self` to resolve references. |
| <a name="oas-self"></a>$self | `string` | This string MUST be in the form of a URI reference as defined by [[RFC3986]] [Section 4.1](https://www.rfc-editor.org/rfc/rfc3986#section-4.1). The `$self` field provides the self-assigned URI of this document, which also serves as its base URI in accordance with [[RFC3986]] [Section 5.1.1](https://www.rfc-editor.org/rfc/rfc3986#section-5.1.1). Implementations MUST support identifying the targets of [API description URIs](#relative-references-in-api-description-uris) using the URI defined by this field when it is present. See [Establishing the Base URI](#establishing-the-base-uri) for the base URI behavior when `$self` is absent or relative, and see [Appendix F](#appendix-f-examples-of-base-uri-determination-and-reference-resolution) for examples of using `$self` to resolve references. |
| <a name="oas-info"></a>info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. |
| <a name="oas-json-schema-dialect"></a> jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. |
| <a name="oas-servers"></a>servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be an array consisting of a single [Server Object](#server-object) with a [url](#server-url) value of `/`. |
Expand Down Expand Up @@ -1099,7 +1099,7 @@ examples:
```

A querystring parameter using regular form encoding, but managed with a Media Type Object.
This shows spaces being handled per the `application/x-www-form-urlencoded` media type rules (encode as `+`) rather than the RFC6570 process (encode as `%20`); see [Appendix E](appendix-e-percent-encoding-and-form-media-types) for further guidance on this distinction.
This shows spaces being handled per the `application/x-www-form-urlencoded` media type rules (encode as `+`) rather than the RFC6570 process (encode as `%20`); see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for further guidance on this distinction.
Examples are shown at both the media type and parameter level to emphasize that, since `application/x-www-form-urlencoded` is suitable for use in query strings by definition, no further encoding or escaping is applied to the serialized media type value:

```yaml
Expand Down Expand Up @@ -1857,7 +1857,7 @@ Using `contentEncoding` for a multipart field is equivalent to specifying an [En
If `contentEncoding` is used for a multipart field that has an Encoding Object with a `headers` field containing `Content-Transfer-Encoding` with a schema that disallows the value from `contentEncoding`, the result is undefined for serialization and parsing.

Note that as stated in [Working with Binary Data](#working-with-binary-data), if the Encoding Object's `contentType`, whether set explicitly or implicitly through its default value rules, disagrees with the `contentMediaType` in a Schema Object, the `contentMediaType` SHALL be ignored.
Because of this, and because the Encoding Object's `contentType` defaulting rules do not take the Schema Object's`contentMediaType` into account, the use of `contentMediaType` with an Encoding Object is NOT RECOMMENDED.
Because of this, and because the Encoding Object's `contentType` defaulting rules do not take the Schema Object's `contentMediaType` into account, the use of `contentMediaType` with an Encoding Object is NOT RECOMMENDED.

Note also that `Content-Transfer-Encoding` is deprecated for `multipart/form-data` ([RFC7578](https://www.rfc-editor.org/rfc/rfc7578.html#section-4.7)) where binary data is supported, as it is in HTTP.

Expand Down Expand Up @@ -1991,7 +1991,7 @@ multipart/mixed:
As described in [[?RFC2557]], a set of resources making up a web page can be sent in a `multipart/related` payload, preserving links from the `text/html` document to subsidiary resources such as scripts, style sheets, and images by defining a `Content-Location` header for each page.
The first part is used as the root resource (unless using `Content-ID`, which RFC2557 advises against and is forbidden in this example), so we use `prefixItems` and `prefixEncoding` to define that it must be an HTML resource, and then allow any of several different types of resources in any order to follow.

The `Content-Location` header is defined using `content: {text/plain: {...}}` to avoid percent-encoding its URI value; see [Appendix D](appendix-d-serializing-headers-and-cookies) for further details.
The `Content-Location` header is defined using `content: {text/plain: {...}}` to avoid percent-encoding its URI value; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for further details.

```yaml
components:
Expand Down Expand Up @@ -2051,7 +2051,7 @@ multipart/mixed:

For `multipart/byteranges` [[RFC9110]] [Section 14.6](https://www.rfc-editor.org/rfc/rfc9110.html#section-14.6), a `Content-Range` header is required:

See [Appendix D](appendix-d-serializing-headers-and-cookies) for an explanation of why `content: {text/plain: {...}}` is used to describe the header value.
See [Appendix D](#appendix-d-serializing-headers-and-cookies) for an explanation of why `content: {text/plain: {...}}` is used to describe the header value.

```yaml
multipart/byteranges:
Expand Down Expand Up @@ -2789,7 +2789,7 @@ For HTTP messages, this is purely a serialization concern, and no more of a prob

However, because examples and values modeled with `content` do not incorporate the header name, for these fields `Set-Cookie` MUST be handled by placing each value on a separate line, without the header name or the `:` delimiter.

Note also that any URI percent-encoding, base64 encoding, or other escaping MUST be performed prior to supplying the data to OAS tooling; see [Appendix D](appendix-d-serializing-headers-and-cookies) for details.
Note also that any URI percent-encoding, base64 encoding, or other escaping MUST be performed prior to supplying the data to OAS tooling; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for details.

The following example shows two different ways to describe `Set-Cookie` headers that require cookies named `"lang"` and `"foo"`, as well as a `"urlSafeData"` cookie that is expected to be percent-encoded. The first uses `content` in order to show exactly how such examples are formatted, but also notes the limitations of schema constraints with multi-line text. The second shows the use of `style: "simple"`, which produces the same serialized example text (with each line corresponding to one `Set-Cookie:` line in the HTTP response), but allows schema constraints on each cookie; note that the percent-encoding is already applied in the `dataValue` field of the example:

Expand Down
22 changes: 22 additions & 0 deletions versions/3.1.2-editors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# OpenAPI Specification Editors

## Active

* Henry Andrews [@handrews](https://github.com/handrews)
* Jeremy Whitlock [@whitlockjc](https://github.com/whitlockjc)
* Karen Etheridge [@karenetheridge](https://github.com/karenetheridge)
* Lorna Mitchell [@lornajane](https://github.com/lornajane)
* Marsh Gardiner [@earth2marsh](https://github.com/earth2marsh)
* Miguel Quintero [@miqui](https://github.com/miqui)
* Mike Kistler [@mikekistler](https://github.com/mikekistler)
* Ralf Handl [@ralfhandl](https://github.com/ralfhandl)
* Vincent Biret [@baywet](https://github.com/baywet)

## Emeritus

* Ron Ratovsky [@webron](https://github.com/webron)
* Darrel Miller [@darrelmiller](https://github.com/darrelmiller)
* Mike Ralphson [@MikeRalphson](https://github.com/MikeRalphson)
* Uri Sarid [@usarid](https://github.com/usarid)
* Jason Harmon [@jharmn](https://github.com/jharmn)
* Tony Tam [@fehguy](https://github.com/fehguy)
Loading
Loading