From 9cec720521088202d454f91877740a3eee2a4895 Mon Sep 17 00:00:00 2001 From: Towbee05 Date: Tue, 21 Oct 2025 00:13:40 +0100 Subject: [PATCH 1/2] Added table of contents to main readme file --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4a7bff9bc..5909baf4e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,19 @@ **Swagger Client** is a JavaScript module that allows you to fetch, resolve, and interact with Swagger/OpenAPI documents. +## Table of Contents +- [New](#new) +- [Compatibility](#compatibility) +- [Anonymized analytics](#anonymized-analytics) +- [Documentation](#documentation) + - [Usage](#usage) + - [Development](#development) + - [Migrations](#migrations) +- [Runtime](#runtime) + - [Node js](#nodejs) + - [Browsers](#browsers) +- [Security Contact](#security-contact) + ## New! **This is the new version of swagger-js, 3.x.** The new version supports Swagger 2.0 as well as OpenAPI 3. @@ -68,9 +81,9 @@ Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` - [Migration guide](docs/migration/migration-2-x-to-3-x.md) - [Graveyard](docs/migration/graveyard-3-x.md) -### Runtime +## Runtime -### Node.js +#### Node.js `swagger-client` requires Node.js `>=12.20.0` and uses different `fetch` implementation depending on Node.js version. @@ -81,7 +94,7 @@ on Node.js version. > NOTE: swagger-client minimum Node.js runtime version aligns with [Node.js Releases](https://nodejs.org/en/about/releases/) > which means that we can drop support for **EOL** (End Of Life) Node.js versions without doing major version bump. -### Browsers +#### Browsers `swagger-client` works in the latest versions of Chrome, Safari, Firefox, and Edge and uses [native fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) implementation From 5c58b1b7bca82fcbf7e686218f92d0d0f89cc35b Mon Sep 17 00:00:00 2001 From: Towbee05 Date: Sun, 16 Nov 2025 20:10:20 +0100 Subject: [PATCH 2/2] Added table of contents --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4a7bff9bc..b48ae5909 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ **Swagger Client** is a JavaScript module that allows you to fetch, resolve, and interact with Swagger/OpenAPI documents. +## Table of Contents + + - [New](#new) + - [Compatibility](#compatibility) + - [Anonymized analytics](#anonymized-analytics) + - [Documentation](#documentation) + - [Usage](#usage) + - [Development](#development) + - [Migrations](#migrations) + - [Runtime](#runtime) + - [Node js](#nodejs) + - [Browsers](#browsers) + - [Security Contact](#security-contact) + ## New! **This is the new version of swagger-js, 3.x.** The new version supports Swagger 2.0 as well as OpenAPI 3. @@ -48,7 +62,7 @@ Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` ## Documentation -#### Usage +### Usage - [Installation](docs/usage/installation.md) - [Tags Interface](docs/usage/tags-interface.md) @@ -57,18 +71,18 @@ Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` - [HTTP Client](docs/usage/http-client.md) - [Swagger Client API](docs/usage/api.md) -#### Development +### Development - [Contributing](https://github.com/swagger-api/.github/blob/master/CONTRIBUTING.md) - [Setting up](docs/development/setting-up.md) - [Scripts](docs/development/scripts.md) -#### Migrations +### Migrations - [Migration guide](docs/migration/migration-2-x-to-3-x.md) - [Graveyard](docs/migration/graveyard-3-x.md) -### Runtime +## Runtime ### Node.js