Skip to content

Commit 7e372e8

Browse files
MikeRalphsonchar0n
authored andcommitted
fix: update refs to master branch to main (OAI#2546)
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
1 parent 2966d13 commit 7e372e8

11 files changed

+27
-28
lines changed

.github/workflows/convert-examples-to-json.yaml

+4-5
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ name: convert-examples-to-json
1010
# Only the YAML files should be adjusted manually.
1111
#
1212

13-
# run this on push to master
13+
# run this on push to main
1414
on:
1515
push:
1616
branches:
17-
- master
17+
- main
1818

1919
jobs:
2020
yaml2json:
2121

2222
runs-on: ubuntu-latest
2323

2424
steps:
25-
- uses: actions/checkout@v1 # checkout repo content
25+
- uses: actions/checkout@v2 # checkout repo content
2626

2727
- name: Install dependencies
2828
run: npm i
@@ -36,10 +36,9 @@ jobs:
3636
git --no-pager -c color.diff=always diff --staged
3737
3838
- name: Create Pull Request
39-
uses: peter-evans/create-pull-request@v1
39+
uses: peter-evans/create-pull-request@v3
4040
with:
4141
token: ${{ secrets.GITHUB_TOKEN }}
42-
branch-suffix: none
4342
branch: update-json-examples
4443
title: Update JSON example files
4544
commit-message: Update JSON example files

.github/workflows/validate-markdown.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
runs-on: ubuntu-latest
1919

2020
steps:
21-
- uses: actions/checkout@v1 # checkout repo content
21+
- uses: actions/checkout@v2 # checkout repo content
2222
- uses: actions/setup-node@v1 # setup Node.js
2323
with:
2424
node-version: '12.x'

DEVELOPMENT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ Spec changes should be approved by a majority of the committers. Approval can be
4040

4141
* At any given time, there would be *at most* 4 work branches. The branches would exist if work has started on them. Assuming a current version of 3.0.0:
4242

43-
* master - Current stable version. No PRs would be accepted directly to modify the specification. PRs against supporting files can be accepted.
43+
* main - Current stable version. No PRs would be accepted directly to modify the specification. PRs against supporting files can be accepted.
4444

4545
* v3.0.1-dev - The next PATCH version of the specification. This would include non-breaking changes such as typo fixes, document fixes, wording clarifications.
4646

4747
* v3.1.0 - The next MINOR version.
4848

4949
* v4.0.0 - The next MAJOR version.
5050

51-
* The master branch shall remain the current, released OpenAPI Specification. We will describe and link the work branch(es) on the **default** README.md on master.
51+
* The main branch shall remain the current, released OpenAPI Specification. We will describe and link the work branch(es) on the **default** README.md on main.
5252

5353
* Examples of how something is described *currently* vs. the proposed solution should accompany any change proposal.
5454

@@ -62,11 +62,11 @@ Spec changes should be approved by a majority of the committers. Approval can be
6262

6363
* Not all committers will contribute to every single proposed change. There may be many open proposals at once, and multiple efforts may happen in parallel.
6464

65-
* When the work branch is ready and approved, the branch will be merged to master.
65+
* When the work branch is ready and approved, the branch will be merged to main.
6666

6767
## Release Process
6868

69-
A release requires a vote on the release notes by TSC members within the voting period. Major or minor release voting periods will be announced by the Liaison in the Slack channel and noted on the calendar at least 6 days in advance. During this time, TSC members who have not yet voted must note their approval on the GitHub pull request for the release notes. Patch releases happen at the first TSC meeting of a calendar month. The Liaison is responsible for coordinating the actual merge to Master with marketing support, if any.
69+
A release requires a vote on the release notes by TSC members within the voting period. Major or minor release voting periods will be announced by the Liaison in the Slack channel and noted on the calendar at least 6 days in advance. During this time, TSC members who have not yet voted must note their approval on the GitHub pull request for the release notes. Patch releases happen at the first TSC meeting of a calendar month. The Liaison is responsible for coordinating the actual merge to main with marketing support, if any.
7070

7171
* Patch-level releases require majority approval by TSC members. (Max voting period 3 days)
7272

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
3838

3939
The current process for development of the OpenAPI Specification is described in
4040
[Development Guidelines](DEVELOPMENT.md).
41-
Development of 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 master.
41+
Development of 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`.
4242

4343
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 [TSC calendar online](https://openapi.groups.io/g/tsc/calendar), and import it to your calendar using the [iCal link](https://openapi.groups.io/g/tsc/ics/1105671/1995679554/feed.ics).
4444

@@ -53,6 +53,6 @@ Not all feedback can be accommodated and there may be solid arguments for or aga
5353

5454
## Licensing
5555

56-
See: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/master/LICENSE)
56+
See: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/main/LICENSE)
5757

5858
![Analytics](https://ga-beacon.appspot.com/UA-831873-42/readme.md?pixel)

guidelines/v2.0/REUSE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ When referencing locally (within the current document), the target references sh
8181

8282
An example of a local definition reference:
8383

84-
_Example from https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/json/petstore.json_
84+
_Example from https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v2.0/json/petstore.json_
8585
``` json
8686
// ...
8787
"200": {
@@ -100,7 +100,7 @@ _Example from https://github.com/OAI/OpenAPI-Specification/blob/master/examples/
100100

101101
Files can be referred to in relative paths to the current document.
102102

103-
_Example from https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v2.0/json/petstore-separate/spec/swagger.json_
103+
_Example from https://github.com/OAI/OpenAPI-Specification/tree/main/examples/v2.0/json/petstore-separate/spec/swagger.json_
104104

105105
``` json
106106
// ...
@@ -116,7 +116,7 @@ _Example from https://github.com/OAI/OpenAPI-Specification/tree/master/examples/
116116

117117
Remote references may also reference properties within the relative remote file.
118118

119-
_Example from https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v2.0/json/petstore-separate/spec/swagger.json_
119+
_Example from https://github.com/OAI/OpenAPI-Specification/tree/main/examples/v2.0/json/petstore-separate/spec/swagger.json_
120120
``` json
121121
// ...
122122
"parameters": [

proposals/000_OAS-proposal-template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
|Tag |Value |
77
|---- | ---------------- |
8-
|Proposal |[NNNN](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/{directory_or_file_name})|
8+
|Proposal |[NNNN](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{directory_or_file_name})|
99
|Authors|[Author 1](https://github.com/{author1}), [Author 2](https://github.com/{author2})|
1010
|Review Manager |TBD |
1111
|Status |Proposal, Draft, Promoted, or Abandoned|
12-
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/{NNNN}/implementations.md)|
12+
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{NNNN}/implementations.md)|
1313
|Issues |[{issueid}](https://github.com/OAI/OpenAPI-Specification/issues/{Issueid})|
1414
|Previous Revisions |[{revid}](https://github.com/OAI/OpenAPI-Specification/pull/{revid}) |
1515

proposals/001_Alternative Schema Proposal.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
|Tag |Value |
66
|---- | ---------------- |
7-
|Proposal |[Alternative Schema](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema)|
7+
|Proposal |[Alternative Schema](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/Alternative%20Schema)|
88
|Authors|[Chuck Heazel](https://github.com/{cmheazel})|
99
|Review Manager |TBD |
1010
|Status |**Draft** |
11-
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema/implementations.md)
11+
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/Alternative%20Schema/implementations.md)
1212
|Issues |[1532](https://github.com/OAI/OpenAPI-Specification/issues/1532)|
1313
|Previous Revisions |[March 15](https://github.com/OAI/OpenAPI-Specification/pull/1868#issue-261689900) |
1414

@@ -42,14 +42,14 @@ This proposal makes the following changes to the OAS 3.0 specification:
4242

4343
### Extend the Schema Object
4444

45-
The OpenAPI Schema Object is extended by the addition of the x-oas-draft-alternativeSchema field. The proposed changes to the OpenAPI specification are provided in [schema_object.md](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema/schema_object.md)
45+
The OpenAPI Schema Object is extended by the addition of the x-oas-draft-alternativeSchema field. The proposed changes to the OpenAPI specification are provided in [schema_object.md](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/Alternative%20Schema/schema_object.md)
4646

4747
### Add the Alternative Schema Object
4848

49-
The new object, the Alternative Schema Object is added to the OpenAPI specification. The proposed changes to the OpenAPI specification are provided in [alternative_schema_object.md](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema/alternative_schema_object.md)
49+
The new object, the Alternative Schema Object is added to the OpenAPI specification. The proposed changes to the OpenAPI specification are provided in [alternative_schema_object.md](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/Alternative%20Schema/alternative_schema_object.md)
5050

5151
### Provide Alternative Schema Examples
52-
Examples of the use of the Alternative Schema capability is added to the OpenAPI specification. The proposed changes to the OpenAPI specification are provided in [alternative_schema_examples.md](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema/alternative_schema_examples.md)
52+
Examples of the use of the Alternative Schema capability is added to the OpenAPI specification. The proposed changes to the OpenAPI specification are provided in [alternative_schema_examples.md](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/Alternative%20Schema/alternative_schema_examples.md)
5353

5454
### Alternative Schema Registry
5555

proposals/002_Webhooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
|Tag |Value |
77
|---- | ---------------- |
8-
|Proposal |[002_Webhooks](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/002_webhooks.md)|
8+
|Proposal |[002_Webhooks](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/002_webhooks.md)|
99
|Authors|[Lorna Mitchell](https://github.com/lornajane)|
1010
|Review Manager |TBD |
1111
|Status |Proposal|

proposals/003_Clarify-Nullable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
|Tag |Value |
77
|---- | ---------------- |
8-
|Proposal |[003](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/003_Clarify-Nullable.md)|
8+
|Proposal |[003](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/003_Clarify-Nullable.md)|
99
|Authors|[Ted Epstein](https://github.com/tedepstein)|
1010
|Review Manager |TBD|
1111
|Status |Proposal|

proposals/004_Overlays.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
|Tag |Value |
66
|---- | ---------------- |
7-
|Proposal |[004_Overlays](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/004_overlays.md)|
7+
|Proposal |[004_Overlays](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/004_overlays.md)|
88
|Authors|[Darrel Miller](https://github.com/darrelmiller)|
99
|Status |Proposal|
1010
|Issues |[1442](https://github.com/OAI/OpenAPI-Specification/issues/1442) [1722](https://github.com/OAI/OpenAPI-Specification/issues/1722)|

proposals/Alternative Schema/schema_object.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ The following content shall be used to replace the Fixed Fields table in the Sch
77
|Field Name | Type | Description |
88
|---|:---:|---|
99
| nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`.|
10-
| discriminator | [Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#discriminatorObject) | Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See [Composition and Inheritance](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaComposition) for more details. |
10+
| discriminator | [Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#discriminatorObject) | Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See [Composition and Inheritance](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaComposition) for more details. |
1111
| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as `readOnly` being `true` and is in the `required` list, the `required` will take effect on the response only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. |
1212
| writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as `writeOnly` being `true` and is in the `required` list, the `required` will take effect on the request only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. |
13-
| xml | [XML Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#xmlObject) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. |
14-
| externalDocs | [External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#externalDocumentationObject) | Additional external documentation for this schema.
13+
| xml | [XML Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#xmlObject) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. |
14+
| externalDocs | [External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#externalDocumentationObject) | Additional external documentation for this schema.
1515
| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.|
1616
| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`.|
1717
|x-oas-draft-alternativeSchema |alternative Schema Object |An external schema that participates in the validation of content along with other schema keywords. |

0 commit comments

Comments
 (0)