Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 3.0.4.md to fix broken links #3029

Closed
wants to merge 98 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
d5307af
Fix broken YAML in examples/v3.0/api-with-examples.yaml
eemeli May 2, 2019
4a8bae9
Fix additional broken YAML in examples/v3.0/api-with-examples.yaml
eemeli May 3, 2019
9218ce6
Remove duplicated paragraph in README.md (#2150)
josteink Feb 21, 2020
76f184b
#2157: Update schema to validate refs in headers of encoding objects
alasdairhurst Feb 25, 2020
e42b090
Update README.md to discourage +1 comments on issues (#2134)
MikeRalphson Feb 26, 2020
c5e9a8a
Merge pull request #1914 from eemeli/fix-example-yaml
earth2marsh Apr 9, 2020
52f4e1a
actions: convert-examples-to-json (js version) (#2199)
MikeRalphson Jun 18, 2020
a5aad2b
v3.1.0-rc0 Release (#2251)
webron Jun 18, 2020
55f80d1
Update README.md (#2253)
webron Jun 18, 2020
53c50e1
Fixing oopsie (#2270)
webron Jun 18, 2020
97ec145
Update build badge in README.md (#2271)
MikeRalphson Jul 2, 2020
97ec9eb
Update uspto.yaml (#2221)
philb-lr Jul 2, 2020
d1cc440
Update JSON example files (#2268)
github-actions[bot] Jul 2, 2020
5285c69
Update TOB.md (#2291)
ncaidin Jul 20, 2020
f8449d1
v3.1.0-rc1 Release (#2370)
webron Oct 9, 2020
2e10c7a
Add adopted CODE_OF_CONDUCT.md (#2416)
MikeRalphson Dec 3, 2020
e32baaa
Added wording to clarify scope of references (#2435)
darrelmiller Jan 14, 2021
f1adc84
Fixed the webhook example (#2434)
christianfds Feb 11, 2021
42a9e3d
3.1.0 Release (#2462)
webron Feb 16, 2021
f7ef3c9
Add schemas for 3.1
jdesrosiers Mar 2, 2021
eccada9
3.1 Schema: Extend schema to use OAS base vocabulary
jdesrosiers Mar 3, 2021
bd7a645
3.1 Schema: Move scripts and tests to root
jdesrosiers Mar 3, 2021
5cde0f0
3.1 Schema: Fixes from code review during TSC meeting
jdesrosiers Mar 11, 2021
84ea4a0
3.1 Schema: Fix anchoring in regexes
jdesrosiers Mar 15, 2021
b5bf761
3.1 Schema: Add media-range format for content objects
jdesrosiers Mar 19, 2021
1ce46a0
3.1 Schema: Remove submodule
jdesrosiers Mar 20, 2021
0f9d3ec
Merge pull request #2489 from jdesrosiers/oas31-schema-2
MikeRalphson Mar 25, 2021
6e5b27a
Updated Overlay proposal (#2300)
darrelmiller Apr 1, 2021
14c0908
Added example of making overlays work like traits (#2534)
darrelmiller Apr 12, 2021
54b0264
servers is an array of server (#2526)
sami-akkawi Apr 15, 2021
9092530
Add "put" to allowed property name for PathItem in 3.1 schema
jdesrosiers Apr 7, 2021
08d22f6
Update $id for release
jdesrosiers Apr 15, 2021
54edcf0
Merge pull request #2524 from jdesrosiers/fix-path-items-missing-put
MikeRalphson Apr 16, 2021
5b55a13
fix: update refs to master branch to main (#2546)
MikeRalphson Apr 18, 2021
912498e
Update TOB.md
ncaidin Apr 26, 2021
1adfe30
Merge pull request #2554 from OAI/ncaidin-patch-1
earth2marsh Apr 29, 2021
a295d9a
feat: add agenda workflow/template (#2571)
MikeRalphson May 20, 2021
cc45c37
Add script and GitHub action to automatically generate ReSpec version…
MikeRalphson May 20, 2021
44dc747
docs: add CodeTriage badge and CTA to README.md
MikeRalphson May 21, 2021
ecc6ef3
v3.1 Schema bugfix: Update URI fields to use uri-reference or uri whe…
jdesrosiers May 27, 2021
12f1646
Fix typo in v3.1 schema-base schema (#2544)
jdesrosiers May 27, 2021
bad2228
Merge pull request #2588 from MikeRalphson/codetriage
MikeRalphson May 27, 2021
a1bbb55
Update README.md (#2561)
ncaidin May 27, 2021
347f361
scripts: add fwdport/fwdabort.sh for forward porting commits between …
MikeRalphson Jun 3, 2021
be76894
Respec fix and SEO changes (#2603)
MikeRalphson Jun 3, 2021
946f590
nuke proposal prefixes (#2604)
MikeRalphson Jun 10, 2021
3d2c044
Rendered spec, generate latest.html and add DOCTYPE (#2607)
MikeRalphson Jun 10, 2021
fe41bac
tests: add comments to expected failure cases (#2608)
MikeRalphson Jun 10, 2021
851a6d1
Add a GitHub workflow to run the metaschema tests (incl. boolean sche…
MikeRalphson Jun 10, 2021
df62e1e
Add accessible meetings slide to agenda template
MikeRalphson Jun 10, 2021
8c547b2
Make agenda workflow run on Mondays
MikeRalphson Jun 11, 2021
9d3895a
Add code-of-conduct link to agenda template
MikeRalphson Jun 11, 2021
2d1f573
Merge pull request #2158 from alasdairhurst/master
MikeRalphson Jun 24, 2021
d9ac75b
Merge pull request #2616 from OAI/mr/agenda-add-slide
MikeRalphson Jun 24, 2021
4b1433d
Add scopes as required field of OAuth Flow Object (#2673)
char0n Aug 19, 2021
92df7ca
fix: typo spelling grammar (#2670)
slowy07 Aug 20, 2021
17ed07c
Generate YAML versions of these schema documents (#2669)
karenetheridge Sep 23, 2021
9acd3db
minor simplification of v3.1 schema (#2671)
karenetheridge Sep 23, 2021
085be94
per the spec, the only allowed ranges are [12345]XX (#2690)
karenetheridge Sep 23, 2021
866a4a2
Add "type" qualifier to ensure that "if" clauses fail properly (#2696)
karenetheridge Sep 23, 2021
f6d3005
Treat security scheme as case insensitive (#2706)
hornworm61 Sep 23, 2021
917d330
Add Code of Conduct Enforcement Guidelines (#2721)
tbarn Sep 23, 2021
424e706
fix: invalid JSON in v3.1 schema (#2725)
seriousme Sep 24, 2021
ce732af
tighten up regex for path items (#2681)
karenetheridge Sep 27, 2021
413b1a8
Update 3.1 schema id for patch release (#2718)
jdesrosiers Oct 7, 2021
6ba1577
Create SPECIAL_INTEREST_GROUPS.md (#2686)
ncaidin Oct 7, 2021
20f4bf2
schema fixes for the "parameter" and "header" objects (#2746)
karenetheridge Nov 11, 2021
9d2bc17
Remove Koa2-OAS3 from IMPLEMENTATIONS.md (#2708)
dzjuck Nov 11, 2021
746b830
Add RapiDoc to IMPLEMENTATIONS.md (#2683)
waldyrious Nov 11, 2021
3aaace7
added JSONSchema::Validator to implementations list (#2659)
Logioniz Nov 11, 2021
5984314
Add Schemathesis to the "Testing tools" section (#2553)
Stranger6667 Nov 11, 2021
1974880
examples: add non-oauth-scopes.yaml, refs #2407 (#2515)
MikeRalphson Nov 11, 2021
99f8331
Add implementations (#2469)
vearutop Nov 11, 2021
a8bd1a5
Change server-variable property to 'description' (#2793)
ahoglund Nov 18, 2021
a114313
reference the relevant section of the spec in definitions (#2792)
karenetheridge Nov 18, 2021
ba59ea1
IMPLEMENTATIONS.md: Restore table header format (#2787)
waldyrious Nov 18, 2021
a48adb9
Update JSON example files (#2786)
github-actions[bot] Nov 18, 2021
f3ffc79
Update Proposal 003 "Clarify Nullable" to Promoted status (#2529)
tedepstein Nov 18, 2021
1fb4f83
Update IMPLEMENTATIONS.md (#2353)
micha-f Nov 18, 2021
115cacc
fix: some broken IETF links (#2798)
saibotsivad Dec 23, 2021
af79cf0
The value field and externalValue field are mutually exclusive. (#2801)
karenetheridge Dec 29, 2021
42c153c
more schema tweaks for parameter objects (#2811)
karenetheridge Dec 29, 2021
dabbcee
add format checks to these strings
karenetheridge Jan 7, 2022
371413f
Merge pull request #2850 from karenetheridge/ether/more-uris
earth2marsh Feb 3, 2022
c0e63d6
Update IMPLEMENTATIONS.md (#2797)
nfroidure Feb 11, 2022
ba36b28
Testing tools: Add Tcases for OpenAPI (#2878)
kerrykimbrough Feb 11, 2022
80c781e
add description to all schemas (#2802)
karenetheridge Feb 24, 2022
dfc8292
document the default for /servers (#2861)
karenetheridge Feb 24, 2022
f6f9ab3
"The Responses Object MUST contain at least one response code" (#2799)
karenetheridge Feb 24, 2022
a1facce
Bump schema version numbers for 2022-02-17 release (#2888)
jdesrosiers Mar 10, 2022
733c879
Make PathItem operation properties specific. (#2127)
axelcostaspena Mar 27, 2022
3e48c1e
Add Connexion Python framework (#2323)
m-aciek Mar 27, 2022
949af1f
add oasdiff tool (#2494)
Mar 27, 2022
7716b92
Update README.md (#2907)
namdeirf Mar 31, 2022
cede0ea
Updated file to reflect release of 3.0, etc. (#2906)
namdeirf Mar 31, 2022
aa91a19
implementations - add aiopenapi3 (#2916)
commonism Apr 20, 2022
65d2a9f
Add a ref to implementation of v3.1 in Go (#3008)
SVilgelm Aug 26, 2022
e61c0f6
Update 3.0.3.md
mojorero Sep 12, 2022
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
22 changes: 22 additions & 0 deletions .github/templates/agenda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
**NOTE: This meeting is on Thursday at 9am - 10am PT**

Zoom Meeting link: [https://zoom.us/j/975841675](https://zoom.us/j/975841675?pwd=SUh4MjRLaEFKNlI3RElpWTdhRDVVUT09). Dial-in passcode: 763054 - [Code-of-Conduct](https://github.com/OAI/OpenAPI-Specification/blob/main/CODE_OF_CONDUCT.md#code-of-conduct)

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.

**Please submit comments below for topics or proposals that you wish to present in the TDC meeting**

![F10B5460-B4B3-4463-9CDE-C7F782202EA9](https://user-images.githubusercontent.com/21603/121568843-0b260900-ca18-11eb-9362-69fda4162be8.jpeg)

The agenda backlog is currently maintained in issue #2482

| Topic | Owner | Decision/NextStep |
|-------|---------|---------|
| | | |
Reports from Special Interest Groups | TDC | |
AOB (see below) | TDC | |
New issues / PRs labelled [review](https://github.com/OAI/OpenAPI-Specification/labels/review) | @OAI/triage | |
[New issues](https://github.com/search?q=repo%3Aoai%2Fopenapi-specification+is%3Aissue+comments%3A0+no%3Alabel+is%3Aopen) without response yet | @OAI/triage | |


/cc @OAI/tsc Please suggest items for inclusion
29 changes: 29 additions & 0 deletions .github/workflows/agenda.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: agenda

# author: @MikeRalphson
# issue: various

#
# This workflow creates the agenda issue each week. It runs on a cron every
# Monday morning, raising an issue for the following Thursday.
# It can also be run manually, in case GitHub Actions has a failure.
#

on:
schedule:
- cron: '0 9 * * 1'
workflow_dispatch: {}

jobs:
agenda:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1 # checkout repo content

- name: Create agenda issue
run: gh issue create -l Housekeeping -t "Open Community (TDC) Meeting, `date --date='next Thu' +'%A %d %B %Y'`" -F .github/templates/agenda.md

49 changes: 49 additions & 0 deletions .github/workflows/convert-examples-to-json.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: convert-examples-to-json

# author: @MikeRalphson / @cebe
# issue: https://github.com/OAI/OpenAPI-Specification/issues/1385

#
# This workflow updates the *.json files in the examples/v3.x directories,
# when the corresponding *.yaml files change.
# JSON example files are automatically generated from the YAML example files.
# Only the YAML files should be adjusted manually.
#

# run this on push to main
on:
push:
branches:
- main

jobs:
yaml2json:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2 # checkout repo content

- name: Install dependencies
run: npm i

- name: convert YAML examples to JSON
run: find examples/v3* -type f -name "*.yaml" | xargs node scripts/yaml2json/yaml2json.js

- name: git diff
run: |
git add examples/**/*.json
git --no-pager -c color.diff=always diff --staged

- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: update-json-examples
title: Update JSON example files
commit-message: Update JSON example files
body: |
This pull request is automatically triggered by GitHub action `convert-examples-to-json`.

The examples/v3.* YAML files have changed, so the JSON files are automatically being recreated.

57 changes: 57 additions & 0 deletions .github/workflows/respec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: respec

# author: @MikeRalphson
# issue: https://github.com/OAI/OpenAPI-Specification/issues/1564

#
# This workflow updates the respec 'pretty' rendered versions of the spec
# on the gh-pages branch when the corresponding markdown files change.
#

# run this on push to main
on:
push:
branches:
- main
workflow_dispatch: {}

jobs:
respec:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2 # checkout main branch
with:
fetch-depth: 0

- name: Install dependencies
run: npm i

- uses: actions/checkout@v2 # checkout gh-pages branch
with:
ref: gh-pages
path: deploy

- name: run main script
run: scripts/md2html/build.sh

- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: update-respec-version
base: gh-pages
delete-branch: true
path: deploy
labels: Housekeeping
reviewers: webron,darrelmiller
title: Update ReSpec versions
commit-message: Update ReSpec versions
signoff: true
body: |
This pull request is automatically triggered by GitHub action `respec`.

The versions/v*.md files have changed, so the HTML files are automatically being regenerated.


31 changes: 31 additions & 0 deletions .github/workflows/schema-tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: schema-test

# Author: @MikeRalphson / runs @jdesrosiers tests
# Issue: https://github.com/OAI/OpenAPI-Specification/pull/2489

#
# This workflow runs the npm test script to validate passing and failing
# testcases for the metaschema.
#

# run this on push to any branch and creation of pull-requests
on:
push: {}
pull_request: {}
workflow_dispatch: {}

jobs:
test:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1 # checkout repo content
- uses: actions/setup-node@v1 # setup Node.js
with:
node-version: '14.x'
- name: Install dependencies
run: npm i
- name: Run tests
run: npm run test

4 changes: 2 additions & 2 deletions .github/workflows/validate-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1 # checkout repo content
- uses: actions/checkout@v2 # checkout repo content
- uses: actions/setup-node@v1 # setup Node.js
with:
node-version: '12.x'
node-version: '14.x'
- name: Validate markdown
run: npx mdv versions/3.*.md

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
target
atlassian-ide-plugin.xml
node_modules/
package-lock.json
deploy/
history
Gemfile.lock
Empty file added .gitmodules
Empty file.
155 changes: 155 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
Code of Conduct
===============

OpenAPI Initiative Code of Conduct

*The Linux Foundation*

*Effective November 24, 2020*

The OpenAPI Initiative (OAI) is an open source Linux Foundation project
and home of the OpenAPI Specification (OAS) released under the Apache
2.0 license. As contributors, maintainers, and participants in this
project, we want to foster an open and welcoming environment. We pledge
to make participation in our project and our community a harassment-free
experience for everyone, regardless of age, body size, disability,
ethnicity, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

Our Standards
-------------

Examples of behaviors that contribute to creating a positive environment
include:

- Using welcoming and inclusive language

- Being respectful of differing viewpoints and experiences

- Gracefully accepting constructive criticism

- Focusing on what is best for the community

- Showing empathy towards other community members

- Assuming the best intent from others

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances

- Making unsolicited, insulting or derogatory comments, including personal (i.e., ad hominem) or political attacks to create conflict (e.g., trolling)

- Public or private harassment

- Publishing others' private information, such as a physical or electronic address, without explicit permission (e.g., doxxing)

- Threatening, offensive, harmful comments, or behavior

- Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities
--------------------

The Code of Conduct Committee is responsible for clarifying the
standards of acceptable behavior and is expected to take appropriate and
fair corrective action in response to any instances of unacceptable
behavior.

Scope
-----

This Code of Conduct applies to OAI project spaces, as well as
interactions in public spaces. Project spaces include, but are not
limited to, official OAI code repositories, Slack, mailing lists,
meetings, and events. Public spaces may include venues where an
individual is representing the project or its community. Examples of
this include a community member's email communication, forum posts,
social media activity, or acting as a representative at an online or
offline event. In addition, violations of this code of conduct outside
of these spaces may affect a person's ability to participate in them.

Enforcement
-----------

To report instances of abuse, harassment, or otherwise unacceptable
behavior, contact
[conduct\@openapis.org](mailto:[email protected]). **We
are committed to maintaining the confidentiality of anyone reporting an
incident**. The Code of Conduct Committee will review and investigate
all complaints, responding as deemed necessary and appropriate to the
circumstances. For incidents relating to offline events, we aim to
respond to reports within 24 hours, and for incidents relating to online
activities, we aim to respond to reports within 7 days.

The Code of Conduct Committee has the right and responsibility to
remove, edit, or reject comments, commits, code, wiki edits, issues, and
other contributions that are not aligned to this Code of Conduct, or
take other appropriate action as deemed necessary for behaviors contrary
to the standards listed above. In the case of offline or in-person
events, if a participant engages in behavior that is not aligned to this
Code of Conduct, the committee may take action, such as warning the
offender, banning the offender from various online spaces (temporary or
permanent), removing the offender from an event with no refund, or other
options deemed appropriate.

Enforcement Guidelines
----------------------

The Code of Conduct committee will follow these Enforcement Guidelines in
determining the consequences for any action they deem in violation of this
Code of Conduct:

#### 1. Correction
Community Impact: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

Consequence: A private, written warning from the Code of Conduct committee,
providing clarity around the nature of the violation and an explanation of
why the behavior was inappropriate. A public apology may be requested.

#### 2. Warning
Community Impact: A violation through a single incident or series of
actions.

Consequence: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction
with the Code of Conduct committee, for a specified period of time. This
includes avoiding interactions in community spaces as well as external
channels like social media. Violating these terms may lead to a temporary
or permanent ban.

#### 3. Temporary Ban
Community Impact: A serious violation of community standards, including
sustained inappropriate behavior.

Consequence: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No
public or private interaction with the people involved, including
unsolicited interaction with the Code of Conduct committee, is allowed
during this period. Violating these terms may lead to a permanent ban.

#### 4. Permanent Ban
Community Impact: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of
an individual, or aggression toward or disparagement of classes of
individuals.

Consequence: A permanent ban from any sort of public interaction
within the community.

### Events

Some OpenAPI events are governed by the [Linux Foundation Code of
Conduct](https://events.linuxfoundation.org/about/code-of-conduct/)
(E.g. API Specifications Conference) and will be listed on the event
page. The OAI Code of Conduct is designed to be compatible with the
above policy and also includes more details on responding to incidents.

### Attribution

This code of conduct is adapted from the [Contributor Covenant, version
1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct)
and the [PyCon 2019 Code of
Conduct](https://us.pycon.org/2019/about/code-of-conduct/).
Loading