Skip to content

Commit 325db7f

Browse files
tedepsteintedepstein
committed
Merge branch 'main' of https://github.com/OAI/OpenAPI-Specification into patch-5
2 parents 729378c + 851a6d1 commit 325db7f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+981
-129
lines changed

‎.github/templates/agenda.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
**NOTE: This meeting is on Thursday at 9am - 10am PT**
2+
3+
Zoom Meeting link: [https://zoom.us/j/975841675](https://zoom.us/j/975841675?pwd=SUh4MjRLaEFKNlI3RElpWTdhRDVVUT09). Dial-in passcode: 763054
4+
5+
In order to give some more visibility into the topics we cover in the TDC meetings here is the planned agenda for the next meeting. Hopefully this will allow people to plan to attend meetings for topics that they have an interest in. And for folks who cannot attend they can comment on this issue prior to the meeting. Feel free to suggest other potential agenda topics.
6+
7+
**Please submit comments below for topics or proposals that you wish to present in the TDC meeting**
8+
9+
The agenda backlog is currently maintained in issue #2482
10+
11+
| Topic | Owner | Decision/NextStep |
12+
|-------|---------|---------|
13+
| | | |
14+
AOB (see below) | TDC | |
15+
New issues / PRs labelled [review](https://github.com/OAI/OpenAPI-Specification/labels/review) | @OAI/triage | |
16+
[New issues](https://github.com/search?q=repo%3Aoai%2Fopenapi-specification+is%3Aissue+comments%3A0+no%3Alabel+is%3Aopen) without response yet | @OAI/triage | |
17+
18+
19+
/cc @OAI/tsc Please suggest items for inclusion

‎.github/workflows/agenda.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: agenda
2+
3+
# author: @MikeRalphson
4+
# issue: various
5+
6+
#
7+
# This workflow creates the agenda issue each week. It runs on a cron every
8+
# Monday morning, raising an issue for the following Thursday.
9+
# It can also be run manually, in case GitHub Actions has a failure.
10+
#
11+
12+
on:
13+
schedule:
14+
- cron: '0 9 * * 2'
15+
workflow_dispatch: {}
16+
17+
jobs:
18+
agenda:
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21+
22+
runs-on: ubuntu-latest
23+
24+
steps:
25+
- uses: actions/checkout@v1 # checkout repo content
26+
27+
- name: Create agenda issue
28+
run: gh issue create -l Housekeeping -t "Open Community (TDC) Meeting, `date --date='next Thu' +'%A %d %B %Y'`" -F .github/templates/agenda.md
29+

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

Lines changed: 4 additions & 5 deletions
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/respec.yaml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: respec
2+
3+
# author: @MikeRalphson
4+
# issue: https://github.com/OAI/OpenAPI-Specification/issues/1564
5+
6+
#
7+
# This workflow updates the respec 'pretty' rendered versions of the spec
8+
# on the gh-pages branch when the corresponding markdown files change.
9+
#
10+
11+
# run this on push to main
12+
on:
13+
push:
14+
branches:
15+
- main
16+
workflow_dispatch: {}
17+
18+
jobs:
19+
respec:
20+
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- uses: actions/checkout@v2 # checkout main branch
25+
with:
26+
fetch-depth: 0
27+
28+
- name: Install dependencies
29+
run: npm i
30+
31+
- uses: actions/checkout@v2 # checkout gh-pages branch
32+
with:
33+
ref: gh-pages
34+
path: deploy
35+
36+
- name: run main script
37+
run: scripts/md2html/build.sh
38+
39+
- name: Create Pull Request
40+
uses: peter-evans/create-pull-request@v3
41+
with:
42+
token: ${{ secrets.GITHUB_TOKEN }}
43+
branch: update-respec-version
44+
base: gh-pages
45+
delete-branch: true
46+
path: deploy
47+
labels: Housekeeping
48+
reviewers: webron,darrelmiller
49+
title: Update ReSpec versions
50+
commit-message: Update ReSpec versions
51+
signoff: true
52+
body: |
53+
This pull request is automatically triggered by GitHub action `respec`.
54+
55+
The versions/v*.md files have changed, so the HTML files are automatically being regenerated.
56+
57+

‎.github/workflows/schema-tests.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: schema-test
2+
3+
# Author: @MikeRalphson / runs @jdesrosiers tests
4+
# Issue: https://github.com/OAI/OpenAPI-Specification/pull/2489
5+
6+
#
7+
# This workflow runs the npm test script to validate passing and failing
8+
# testcases for the metaschema.
9+
#
10+
11+
# run this on push to any branch and creation of pull-requests
12+
on:
13+
push: {}
14+
pull_request: {}
15+
workflow_dispatch: {}
16+
17+
jobs:
18+
test:
19+
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- uses: actions/checkout@v1 # checkout repo content
24+
- uses: actions/setup-node@v1 # setup Node.js
25+
with:
26+
node-version: '14.x'
27+
- name: Install dependencies
28+
run: npm i
29+
- name: Run tests
30+
run: npm run test
31+

‎.github/workflows/validate-markdown.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ 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:
24-
node-version: '12.x'
24+
node-version: '14.x'
2525
- name: Validate markdown
2626
run: npx mdv versions/3.*.md
2727

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ target
66
atlassian-ide-plugin.xml
77
node_modules/
88
package-lock.json
9+
deploy/
10+
history
911
Gemfile.lock

‎DEVELOPMENT.md

Lines changed: 4 additions & 4 deletions
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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The OpenAPI Specification
22

3-
![Build Status](https://github.com/OAI/OpenAPI-Specification/workflows/validate-markdown/badge.svg)
3+
![Build Status](https://github.com/OAI/OpenAPI-Specification/workflows/validate-markdown/badge.svg) [![Issue triagers](https://www.codetriage.com/oai/openapi-specification/badges/users.svg)](https://www.codetriage.com/oai/openapi-specification)
44

55
![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200)
66

@@ -38,21 +38,22 @@ 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

43-
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).
43+
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). Look for the "Subscribe to Calendar" button for instructions on subscribing.
4444

4545
The OpenAPI Initiative encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
4646

4747
* Review the [current specification](versions/3.1.0.md). The human-readable markdown file _is the source of truth_ for the specification.
4848
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
4949
* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by subscribing to the existing issue or PR.
50+
* Subscribe to an open issue a day (or a week) in your inbox via [CodeTriage.com](https://www.codetriage.com/oai/openapi-specification).
5051
* Create an issue to describe a new concern. If possible, propose a solution.
5152

5253
Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.
5354

5455
## Licensing
5556

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

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

‎TOB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Description:
44
> The TOB is responsible for managing conflicts, violations of procedures or guidelines or other issues that cannot be resolved in the TSC for the OAS. For further details please consult the OpenAPI Project Charter.
55
6-
## TSC Elected - terms through May 2021
6+
## TSC Elected - terms through May 2023
77
Isabelle Mauny @isamauny
88

99
Uri Sarid @usarid

‎guidelines/v2.0/REUSE.md

Lines changed: 3 additions & 3 deletions
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": [

‎package.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,20 @@
1212
"url": "https://github.com/OAI/OpenAPI-Specification.git"
1313
},
1414
"license": "Apache-2.0",
15+
"scripts": {
16+
"test": "npx mocha tests/**/test.js"
17+
},
1518
"readmeFilename": "README.md",
1619
"files": [
1720
"README.md",
1821
"schemas/*"
1922
],
20-
"dependencies": {},
23+
"dependencies": {
24+
"cheerio": "^1.0.0-rc.5",
25+
"highlight.js": "^10.6.0",
26+
"markdown-it": "^12.0.4",
27+
"yargs": "^12.0.5"
28+
},
2129
"devDependencies": {
2230
"@hyperjump/json-schema": "^0.17.0",
2331
"chai": "^4.3.1",

‎proposals/000_OAS-proposal-template.md renamed to ‎proposals/2019-01-01-Proposal-Template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
|Tag |Value |
77
|---- | ---------------- |
8-
|Proposal |[NNNN](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/{directory_or_file_name})|
8+
|Proposal |[YYYY-MM-DD-Short-Name](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{YYYY-MM-DD-Short-Name.md})|
99
|Authors|[Author 1](https://github.com/{author1}), [Author 2](https://github.com/{author2})|
10-
|Review Manager |TBD |
10+
|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)|
13-
|Issues |[{issueid}](https://github.com/OAI/OpenAPI-Specification/issues/{Issueid})|
12+
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{YYYY-MM-DD-Short-Name}/implementations.md)|
13+
|Issues |[{issueid}](https://github.com/OAI/OpenAPI-Specification/issues/{IssueId})|
1414
|Previous Revisions |[{revid}](https://github.com/OAI/OpenAPI-Specification/pull/{revid}) |
1515

1616
## Change Log

‎proposals/001_Alternative Schema Proposal.md renamed to ‎proposals/2019-03-15-Alternative-Schema.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
|Tag |Value |
66
|---- | ---------------- |
7-
|Proposal |[Alternative Schema](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/Alternative%20Schema)|
8-
|Authors|[Chuck Heazel](https://github.com/{cmheazel})|
7+
|Proposal |[Alternative Schema](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/2019-03-15-Alternative-Schema.md)|
8+
|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-Schema/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

1515
.Change Log
1616

1717
|Date |Responsible Party |Description |
1818
|---- | ---------------- | ---------- |
19-
|3/15/19 |C. Heazel|Initial Markup Draft |
20-
|4/17/19 |C. Heazel|Re-structured based on Apple Swift|
19+
|2019-03-15 |C. Heazel|Initial Markup Draft |
20+
|2019-04-17 |C. Heazel|Re-structured based on Apple Swift|
2121

2222
## Introduction
2323

@@ -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 renamed to ‎proposals/2019-07-17-Webhooks.md

Lines changed: 1 addition & 1 deletion
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 |[2019-07-17-Webhooks](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/2019-07-17-Webhooks.md)|
99
|Authors|[Lorna Mitchell](https://github.com/lornajane)|
1010
|Review Manager |TBD |
1111
|Status |Proposal|

‎proposals/003_Clarify-Nullable.md renamed to ‎proposals/2019-10-31-Clarify-Nullable.md

Lines changed: 1 addition & 1 deletion
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 |[2019-10-31-Clarify-Nullable](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/2019-10-31-Clarify-Nullable.md)|
99
|Authors|[Ted Epstein](https://github.com/tedepstein)|
1010
|Review Manager |TBD|
1111
|Status |Promoted|

0 commit comments

Comments
 (0)