You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document MUST contain at least one [paths](#pathsObject) field, a [components](#oasComponents) field or a [webhooks](#oasWebhooks) field. An OpenAPI document uses and conforms to the OpenAPI Specification.
@@ -95,21 +95,21 @@ Some examples of possible media type definitions:
95
95
application/vnd.github.v3.diff
96
96
application/vnd.github.v3.patch
97
97
```
98
-
##### <aname="httpCodes"></a>HTTP Status Codes
98
+
##### <aname="httpCodes"></a>HTTP коды статусов ответа (HTTP Status Codes)
99
99
The HTTP Status Codes are used to indicate the status of the executed operation.
100
100
The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
101
101
102
-
## Specification
102
+
## Спецификация
103
103
104
-
### Versions
104
+
### Версии
105
105
106
106
The OpenAPI Specification is versioned using a `major`.`minor`.`patch` versioning scheme. The `major`.`minor` portion of the version string (for example `3.1`) SHALL designate the OAS feature set. *`.patch`* versions address errors in, or provide clarifications to, this document, not the feature set. Tooling which supports OAS 3.1 SHOULD be compatible with all OAS 3.1.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.1.0` and `3.1.1` for example.
107
107
108
108
Occasionally, non-backwards compatible changes may be made in `minor` versions of the OAS where impact is believed to be low relative to the benefit provided.
109
109
110
110
An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the version of the OAS that it uses.
111
111
112
-
### Format
112
+
### Формат
113
113
114
114
An OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format.
115
115
@@ -134,13 +134,13 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
134
134
135
135
**Note:** While APIs may be defined by OpenAPI documents in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML.
An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the author. In the latter case, [`Reference Objects`](#referenceObject) and [`Schema Object`](#schemaObject)`$ref` keywords are used.
140
140
141
141
It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`.
142
142
143
-
### <aname="dataTypes"></a>Data Types
143
+
### <aname="dataTypes"></a>Типы данных
144
144
145
145
Data types in the OAS are based on the types supported by the [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-4.2.1).
146
146
Note that `integer` as a type is also supported and is defined as a JSON number without a fraction or exponent part.
@@ -173,22 +173,22 @@ If a URI contains a fragment identifier, then the fragment should be resolved pe
173
173
174
174
Relative references in [`Schema Objects`](#schemaObject), including any that appear as `$id` values, use the nearest parent `$id` as a Base URI, as described by [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-8.2). If no parent schema contains an `$id`, then the Base URI MUST be determined according to [RFC3986](https://tools.ietf.org/html/rfc3986#section-5.1).
175
175
176
-
### <aname="relativeReferencesURL"></a>Relative References in URLs
176
+
### <aname="relativeReferencesURL"></a>Относительные ссылки в URL-адресах
177
177
178
178
Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
179
179
Unless specified otherwise, relative references are resolved using the URLs defined in the [`Server Object`](#serverObject) as a Base URL. Note that these themselves MAY be relative to the referring document.
180
180
181
-
### Schema
181
+
### Схема
182
182
183
183
In the following description, if a field is not explicitly **REQUIRED** or described with a MUST or SHALL, it can be considered OPTIONAL.
184
184
185
-
#### <aname="oasObject"></a>OpenAPI Object
185
+
#### <aname="oasObject"></a>OpenAPI Объект
186
186
187
187
This is the root object of the [OpenAPI document](#oasDocument).
188
188
189
-
##### Fixed Fields
189
+
##### Фиксированные (зарезервированные) поля
190
190
191
-
Field Name | Type | Description
191
+
Имя поля | Тип | Описание
192
192
---|:---:|---
193
193
<aname="oasVersion"></a>openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string.
194
194
<aname="oasInfo"></a>info | [Info Object](#infoObject) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required.
@@ -224,7 +224,7 @@ Field Name | Type | Description
224
224
225
225
This object MAY be extended with [Specification Extensions](#specificationExtensions).
226
226
227
-
##### Info Object Example
227
+
##### Пример хранения информации о спецификации (Info Object)
228
228
229
229
```json
230
230
{
@@ -260,7 +260,7 @@ license:
260
260
version: 1.0.1
261
261
```
262
262
263
-
#### <a name="contactObject"></a>Contact Object
263
+
#### <a name="contactObject"></a>Контактная информация (Contact Object)
#### <a name="licenseObject"></a>Информация о лицензии (License Object)
294
294
295
295
License information for the exposed API.
296
296
297
-
##### Fixed Fields
297
+
##### Фиксированные (зарезервированные) поля
298
298
299
-
Field Name | Type | Description
299
+
Имя поля | Тип | Описание
300
300
---|:---:|---
301
301
<a name="licenseName"></a>name | `string` | **REQUIRED**. The license name used for the API.
302
302
<a name="licenseIdentifier"></a>identifier | `string` | An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
303
303
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. This MUST be in the form of a URL. The `url` field is mutually exclusive of the `identifier` field.
304
304
305
305
This object MAY be extended with [Specification Extensions](#specificationExtensions).
306
306
307
-
##### License Object Example
307
+
##### Пример информация о лицензии (License Object)
308
308
309
309
```json
310
310
{
@@ -318,7 +318,7 @@ name: Apache 2.0
318
318
identifier: Apache-2.0
319
319
```
320
320
321
-
#### <a name="serverObject"></a>Server Object
321
+
#### <a name="serverObject"></a>Информация о серверах (Server Object)
322
322
323
323
An object representing a Server.
324
324
@@ -3447,9 +3447,9 @@ Two examples of this:
3447
3447
2. The [Path Item Object](#pathItemObject) MAY be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different from hiding the path itself from the [Paths Object](#pathsObject), because the user will be aware of its existence. This allows the documentation provider to finely control what the viewer can see.
3448
3448
3449
3449
3450
-
## <a name="revisionHistory"></a>Appendix A: Revision History
3450
+
## <a name="revisionHistory"></a>Appendix A: История версий
3451
3451
3452
-
Version | Date | Notes
3452
+
Версия | Дата | Замечания
3453
3453
--- | --- | ---
3454
3454
3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0
3455
3455
3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification
0 commit comments