|
7 | 7 | [](https://npm.runkit.com/openapi-server-url-templating) |
8 | 8 | [](https://tidelift.com/subscription/pkg/npm-openapi-server-url-templating?utm_source=npm-openapi-server-url-templating&utm_medium=referral&utm_campaign=readme) |
9 | 9 |
|
10 | | -[Server URL Templating](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object) supports [Server Variables](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object). Variable substitutions will be made when a variable is named in `{`brackets`}`. |
| 10 | +[Server URL Templating](https://spec.openapis.org/oas/v3.1.1.html#server-object) supports [Server Variables](https://spec.openapis.org/oas/v3.1.1.html#server-variable-object). Variable substitutions will be made when a variable is named in `{`brackets`}`. |
11 | 11 |
|
12 | | -This mechanism is used by [Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object) |
13 | | -of [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification). |
| 12 | +This mechanism is used by [Server Object](https://spec.openapis.org/oas/v3.1.1.html#server-object) |
| 13 | +of [OpenAPI specification](https://spec.openapis.org/). |
14 | 14 |
|
15 | | -`openapi-server-url-templating` is a **parser**, **validator** and **substitution mechanism** for OpenAPI Server URL Templating. It supports |
16 | | -Server Object URL Templating defined in following OpenAPI specification versions: |
| 15 | +`openapi-server-url-templating` is a **parser**, **validator** and **substitution mechanism** for OpenAPI Server URL Templating, |
| 16 | +which played a [foundational role](https://github.com/OAI/OpenAPI-Specification/pull/4264) in defining the official ANBF grammar for Server URL Templating. |
17 | 17 |
|
18 | | -- [OpenAPI 3.0.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object) |
19 | | -- [OpenAPI 3.0.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.1.md#server-object) |
20 | | -- [OpenAPI 3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#server-object) |
21 | | -- [OpenAPI 3.0.3](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object) |
22 | | -- [OpenAPI 3.0.4](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#server-object) |
23 | | -- [OpenAPI 3.1.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object) |
24 | | -- [OpenAPI 3.1.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#server-object) |
| 18 | +It supports Server Object URL Templating defined in following OpenAPI specification versions: |
| 19 | + |
| 20 | +- [OpenAPI 3.0.0](https://spec.openapis.org/oas/v3.0.0.html) |
| 21 | +- [OpenAPI 3.0.1](https://spec.openapis.org/oas/v3.0.1.html) |
| 22 | +- [OpenAPI 3.0.2](https://spec.openapis.org/oas/v3.0.2.html) |
| 23 | +- [OpenAPI 3.0.3](https://spec.openapis.org/oas/v3.0.3.html) |
| 24 | +- [OpenAPI 3.0.4](https://spec.openapis.org/oas/v3.0.4.html) |
| 25 | +- [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0.html) |
| 26 | +- [OpenAPI 3.1.1](https://spec.openapis.org/oas/v3.1.1.html) |
25 | 27 |
|
26 | 28 | <table> |
27 | 29 | <tr> |
@@ -207,7 +209,7 @@ test('https://gigantic-server.com/base-path', { strict: true }); // => false (do |
207 | 209 |
|
208 | 210 | #### Substitution |
209 | 211 |
|
210 | | -Substituting a Server URL Templating is as simple as importing the **substitute** function and calling it. |
| 212 | +Performing Server URL template substitution is as simple as importing the **substitute** function and calling it. |
211 | 213 |
|
212 | 214 | ```js |
213 | 215 | import { substitute } from 'openapi-server-url-templating'; |
|
0 commit comments