Skip to content

Typo in style example #3140

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

Closed
wants to merge 86 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
76f184b
#2157: Update schema to validate refs in headers of encoding objects
alasdairhurst Feb 25, 2020
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
d9a862f
operationId in the link object is a string
karenetheridge Jul 2, 2022
4377242
Update README.md
freddy1020 Jul 21, 2022
65d2a9f
Add a ref to implementation of v3.1 in Go (#3008)
SVilgelm Aug 26, 2022
d84b34e
Make PathItem operation properties specific.
karenetheridge Sep 11, 2022
caa9598
Merge pull request #2963 from karenetheridge/ether/link-operationId
whitlockjc Sep 29, 2022
1cade48
Merge pull request #3026 from karenetheridge/ether/pathitem-operations
whitlockjc Sep 29, 2022
ba8510a
v3.1 license schema modified to describe url and identifier as mutual…
arno-di-loreto Oct 6, 2022
157a4c8
Publish v3.1 schemas version 2022-10-07 (#3042)
jdesrosiers Oct 13, 2022
67a6a32
Update to create next agenda on Thursday (#3065)
darrelmiller Nov 17, 2022
b12acf0
Enforce documented /pets pagination size limit (#3070)
TheTeaCat Nov 17, 2022
13b04fd
docs(IMPLEMENTATIONS): add openapi-runtime-expression to the list (#3…
char0n Nov 17, 2022
d17d5c9
Add Bump.sh to user Interfaces list (#3071)
ChristopheDujarric Nov 17, 2022
17fa240
Update IMPLEMENTATIONS.md (#3055)
octavianN Nov 17, 2022
c06c79b
Remove maxLength for operationObject/summary in the v1.2 spec (#3018)
HoldYourWaffle Nov 17, 2022
14cadce
Update JSON example files (#3077)
github-actions[bot] Nov 17, 2022
36a3a67
Merge pull request #2978 from freddy1020/main
earth2marsh Nov 18, 2022
f8dd3c5
Typo in example
ralfhandl Jan 16, 2023
e41ad47
Merge remote-tracking branch 'upstream/v3.1.1-dev' into fix/label-sty…
ralfhandl Jan 19, 2023
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 16 * * 4'
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

9 changes: 4 additions & 5 deletions .github/workflows/convert-examples-to-json.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ name: convert-examples-to-json
# Only the YAML files should be adjusted manually.
#

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

jobs:
yaml2json:

runs-on: ubuntu-latest

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

- name: Install dependencies
run: npm i
Expand All @@ -36,10 +36,9 @@ jobs:
git --no-pager -c color.diff=always diff --staged

- name: Create Pull Request
uses: peter-evans/create-pull-request@v1
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch-suffix: none
branch: update-json-examples
title: Update JSON example files
commit-message: Update JSON example files
Expand Down
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

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ target
atlassian-ide-plugin.xml
node_modules/
package-lock.json
deploy/
history
Gemfile.lock
51 changes: 44 additions & 7 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,50 @@ 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.

Further details of specific enforcement policies are currently being
drafted. When these details are completed we will post updates to our
website for transparency.

Project maintainers who do not report possible incidents or follow
responses in good faith may face temporary or permanent repercussions as
determined by the Code of Conduct Committee.
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

Expand Down
12 changes: 6 additions & 6 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The specification *will evolve over time*. Changes may be made when any of the

For each change in the specification we should *always* consider the following:

* Migration. Is this a construct that has a path from the existing 2.0 specification? If so, how complicated is it to migrate to the proposed change?
* Migration. Is this a construct that has a path from the [existing specification](https://github.com/OAI/OpenAPI-Specification/releases))? If so, how complicated is it to migrate to the proposed change?

* Tooling. Strive to support code generation, software interfaces, spec generation techniques, as well as other utilities. Some features may be impossible to support in different frameworks/languages. These should be documented and considered during the change approval process.

Expand All @@ -36,19 +36,19 @@ Spec changes should be approved by a majority of the committers. Approval can be

* GitHub is the medium of record for all spec designs, use cases, and so on.

* As with 2.0, the **human readable** document is the source of truth. If using a JSON Schema again to document the spec, it is secondary to the human documentation. The documentation should live in a *.md file, in parallel to the 2.0 document (versions/3.0.0.md for example).
* The **human readable** document is the source of truth. If using a JSON Schema again to document the spec, it is secondary to the human documentation. The documentation should live in a *.md file, in parallel to the latest document (versions/3.0.0.md for example).

* 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:

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

* 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.

* v3.1.0 - The next MINOR version.

* v4.0.0 - The next MAJOR version.

* 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.
* 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.

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

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

* 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.

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

## Release Process

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.
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.

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

Expand Down
Loading