Skip to content

Commit 983b855

Browse files
committed
fixed per comments
1 parent 54e270d commit 983b855

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

versions/3.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The schema exposes two types of fields. Fixed fields, which have a declared name
7171

7272
The OAS representation of the API is made of a single file. However, parts of the definitions can be split into separate files, at the discretion of the user. This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions.
7373

74-
By convention, the OAS specification file is named `swagger.json`.
74+
By convention, the Open API Specification (OAS) file is named `swagger.json`.
7575

7676
### Data Types
7777

@@ -98,15 +98,15 @@ password | `string` | `password` | Used to hint UIs the input needs to be obscur
9898

9999
### Schema
100100

101-
#### <a name="oasObject"></a>OAS Object
101+
#### <a name="oasObject"></a>OpenAPI Object
102102

103103
This is the root document object for the API specification. It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier) together into one document.
104104

105105
##### Fixed Fields
106106

107107
Field Name | Type | Description
108108
---|:---:|---
109-
<a name="oasSwagger"></a>oas | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be `"2.0"`.
109+
<a name="oasSwagger"></a>swagger | `string` | **Required.** Specifies the OpenAPI Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be `"2.0"`.
110110
<a name="oasInfo"></a>info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed.
111111
<a name="oasHost"></a>host | `string` | The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the `host` is not included, the host serving the documentation is to be used (including the port). The `host` does not support [path templating](#pathTemplating).
112112
<a name="oasBasePath"></a>basePath | `string` | The base path on which the API is served, which is relative to the [`host`](#oasHost). If it is not included, the API is served directly under the `host`. The value MUST start with a leading slash (`/`). The `basePath` does not support [path templating](#pathTemplating).

0 commit comments

Comments
 (0)