From 078ee6763990f8b25ce77bceefea6501ed2da2ad Mon Sep 17 00:00:00 2001 From: Lorna Mitchell Date: Wed, 30 Oct 2024 09:16:44 +0000 Subject: [PATCH 1/3] Remove 3.1.0-specific words from the README --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 85dd28e3ea..c92fcd3f29 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,9 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project. -## Current Version - 3.1.0 +## Versions -The current version of the OpenAPI specification is [OpenAPI Specification 3.1.0](versions/3.1.0.md). - -### Previous Versions - -This repository also contains all [previous versions](versions). +This repository contains full specification documents for [all published OpenAPI versions](versions). For release notes and RC versions, refer to the [releases page](releases). Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification. From 8160a59a43ba0929e5e29e63cbbb2e93502d4427 Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Wed, 30 Oct 2024 12:30:41 +0000 Subject: [PATCH 2/3] Update README.md Co-authored-by: Ralf Handl --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c92fcd3f29..c13baceaa3 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This GitHub project is the starting point for OpenAPI. Here you will find the in ## Versions -This repository contains full specification documents for [all published OpenAPI versions](versions). For release notes and RC versions, refer to the [releases page](releases). +This repository contains [the Markdown sources](versions) for [all published OpenAPI Specification versions](https://spec.openapis.org/). For release notes and RC versions, refer to the [releases page](releases). Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification. From 17aa9a54c06d0993733bce02f358803f33ca7b0a Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Thu, 31 Oct 2024 14:02:57 +0000 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Mike Kistler Co-authored-by: Henry Andrews --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c13baceaa3..c6f6424d36 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This GitHub project is the starting point for OpenAPI. Here you will find the in ## Versions -This repository contains [the Markdown sources](versions) for [all published OpenAPI Specification versions](https://spec.openapis.org/). For release notes and RC versions, refer to the [releases page](releases). +This repository contains [the Markdown sources](versions) for [all published OpenAPI Specification versions](https://spec.openapis.org/). For release notes and release candidate versions, refer to the [releases page](releases). Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification. @@ -41,7 +41,7 @@ The TSC holds weekly web conferences to review open pull requests and discuss op 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: -* Review the [current specification](https://spec.openapis.org) on the official specification site, which is the source of truth as it includes the full credits and citations. +* Review the specification [markdown sources](versions) and [authoritative _source-of-truth_ HTML renderings](https://spec.openapis.org/), including full credits and citations. * Review the [contributing](CONTRIBUTING.md) process so you understand how the spec is evolving. * Check the [discussions](https://github.com/OAI/OpenAPI-Specification/discussions), [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. * Subscribe to an open issue a day (or a week) in your inbox via [CodeTriage.com](https://www.codetriage.com/oai/openapi-specification).