Skip to content

Commit 670dfbe

Browse files
authored
docs: use new authoritative OpenAPI rendering URLs (#75)
Refs #74
1 parent f168cdd commit 670dfbe

File tree

2 files changed

+21
-13
lines changed

2 files changed

+21
-13
lines changed

NOTICE

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@ openapi-server-url-templating
22
Copyright 2024, Vladimír Gorej
33
openapi-server-url-templating is licensed under Apache 2.0 license.
44
Copy of the Apache 2.0 license can be found in `LICENSE` file.
5+
6+
OpenAPI Specification 3.1.x
7+
Copyright The Linux Foundation
8+
Fragments of the specification text are embedded in `README.md`.
9+
Definition of `server-variable-name` ABNF non-terminal is based on the OpenAPI Specification ABNF.
10+
Copy of the Apache 2.0 license can be found in `LICENSE` file.

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,23 @@
77
[![try on RunKit](https://img.shields.io/badge/try%20on-RunKit-brightgreen.svg?style=flat)](https://npm.runkit.com/openapi-server-url-templating)
88
[![Tidelift](https://tidelift.com/badges/package/npm/openapi-server-url-templating)](https://tidelift.com/subscription/pkg/npm-openapi-server-url-templating?utm_source=npm-openapi-server-url-templating&utm_medium=referral&utm_campaign=readme)
99

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`}`.
1111

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/).
1414

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

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)
2527

2628
<table>
2729
<tr>
@@ -207,7 +209,7 @@ test('https://gigantic-server.com/base-path', { strict: true }); // => false (do
207209

208210
#### Substitution
209211

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

212214
```js
213215
import { substitute } from 'openapi-server-url-templating';

0 commit comments

Comments
 (0)