From e3d2d04926625cd1859aaa6d87b02a135073608a Mon Sep 17 00:00:00 2001 From: Bellangelo Date: Sat, 15 Jun 2024 02:47:37 +0300 Subject: [PATCH] Update examples urls in the specification --- versions/3.0.0.md | 2 +- versions/3.0.1.md | 2 +- versions/3.0.2.md | 2 +- versions/3.0.3.md | 2 +- versions/3.1.0.md | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/versions/3.0.0.md b/versions/3.0.0.md index 84248257b4..f5ee1ecbb9 100644 --- a/versions/3.0.0.md +++ b/versions/3.0.0.md @@ -1821,7 +1821,7 @@ The key value used to identify the callback object is an expression, evaluated a ##### Patterned Fields Field Pattern | Type | Description ---|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. +{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.0/callback-example.yaml) is available. This object MAY be extended with [Specification Extensions](#specification-extensions). diff --git a/versions/3.0.1.md b/versions/3.0.1.md index 2c1ba6c317..6b21b0f62d 100644 --- a/versions/3.0.1.md +++ b/versions/3.0.1.md @@ -1821,7 +1821,7 @@ The key value used to identify the callback object is an expression, evaluated a ##### Patterned Fields Field Pattern | Type | Description ---|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. +{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.0/callback-example.yaml) is available. This object MAY be extended with [Specification Extensions](#specification-extensions). diff --git a/versions/3.0.2.md b/versions/3.0.2.md index ff86a527ce..e67428d1b8 100644 --- a/versions/3.0.2.md +++ b/versions/3.0.2.md @@ -1843,7 +1843,7 @@ The key value used to identify the callback object is an expression, evaluated a ##### Patterned Fields Field Pattern | Type | Description ---|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. +{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.0/callback-example.yaml) is available. This object MAY be extended with [Specification Extensions](#specification-extensions). diff --git a/versions/3.0.3.md b/versions/3.0.3.md index 13a96ea657..086587c983 100644 --- a/versions/3.0.3.md +++ b/versions/3.0.3.md @@ -1847,7 +1847,7 @@ The key value used to identify the path item object is an expression, evaluated ##### Patterned Fields Field Pattern | Type | Description ---|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. +{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.0/callback-example.yaml) is available. This object MAY be extended with [Specification Extensions](#specification-extensions). diff --git a/versions/3.1.0.md b/versions/3.1.0.md index 1f0830643f..3ebb206f4e 100644 --- a/versions/3.1.0.md +++ b/versions/3.1.0.md @@ -195,7 +195,7 @@ Field Name | Type | Description jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. paths | [Paths Object](#paths-object) | The available paths and operations for the API. -webhooks | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] ] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](../examples/v3.1/webhook-example.yaml) is available. +webhooks | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] ] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.1/webhook-example.yaml) is available. components | [Components Object](#components-object) | An element to hold various schemas for the document. security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement (`{}`) can be included in the array. tags | [[Tag Object](#tag-object)] | A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](#operation-object) must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. @@ -1866,7 +1866,7 @@ To describe incoming requests from the API provider independent from another API ##### Patterned Fields Field Pattern | Type | Description ---|:---:|--- -{expression} | [Path Item Object](#path-item-object) \| [Reference Object](#reference-object) | A Path Item Object, or a reference to one, used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. +{expression} | [Path Item Object](#path-item-object) \| [Reference Object](#reference-object) | A Path Item Object, or a reference to one, used to define a callback request and expected responses. A [complete example](https://github.com/OAI/learn.openapis.org/tree/main/examples/v3.0/callback-example.yaml) is available. This object MAY be extended with [Specification Extensions](#specification-extensions).