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
Copy file name to clipboardExpand all lines: versions/3.0.md
+34-34Lines changed: 34 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The OpenAPI Specification (OAS) is a project used to describe and document RESTf
12
12
13
13
14
14
The OpenAPI Specification defines a set of files required to describe such an API.
15
-
These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various programming languages.
15
+
These files can then be used by documentation generation tools to display the API and code generation tools to generate clients in various programming languages.
16
16
17
17
Additional utilities can also take advantage of the resulting files, such as testing tools.
18
18
@@ -131,10 +131,12 @@ By convention, it is RECOMMENDED that the OpenAPI Specification (OAS) file be na
131
131
132
132
### <aname="dataTypes"></a>Data Types
133
133
134
-
Primitive data types in the OAS are based on the types supported by the [JSON Schema Specification Wright Draft 00](https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2). Note that `integer` as a type is also supported and is defined as a JSON number without a fraction or exponent part. `null` is not supported as a value.
134
+
Primitive data types in the OAS are based on the types supported by the [JSON Schema Specification Wright Draft 00](https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2).
135
+
Note that `integer` as a type is also supported and is defined as a JSON number without a fraction or exponent part.
136
+
`null` is not supported as a value.
135
137
Models are described using the [Schema Object](#schemaObject) which is an extended subset of JSON Schema Specification Wright Draft 00.
136
138
137
-
<aname="dataTypeFormat"></a>Primitives have an optional modifier property `format`.
139
+
<aname="dataTypeFormat"></a>Primitives have an optional modifier property:`format`.
138
140
OAS uses several known formats to more finely define the data type being used.
139
141
However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs.
140
142
Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification.
@@ -200,7 +202,7 @@ In subsequent versions of the OpenAPI Specification, care will be given such tha
200
202
#### <aname="infoObject"></a>Info Object
201
203
202
204
The object provides metadata about the API.
203
-
The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
205
+
The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
204
206
205
207
##### Fixed Fields
206
208
@@ -220,13 +222,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
220
222
221
223
```json
222
224
{
223
-
"title": "Swagger Sample App",
225
+
"title": "Sample Pet Store App",
224
226
"description": "This is a sample server for a pet store.",
225
-
"termsOfService": "http://swagger.io/terms/",
227
+
"termsOfService": "http://example.com/terms/",
226
228
"contact": {
227
229
"name": "API Support",
228
-
"url": "http://www.swagger.io/support",
229
-
"email": "support@swagger.io"
230
+
"url": "http://www.example.com/support",
231
+
"email": "support@example.com"
230
232
},
231
233
"license": {
232
234
"name": "Apache 2.0",
@@ -237,13 +239,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
237
239
```
238
240
239
241
```yaml
240
-
title: Swagger Sample App
242
+
title: Sample Pet Store App
241
243
description: This is a sample server for a pet store.
@@ -735,7 +737,7 @@ Describes a single API operation on a path.
735
737
Field Name | Type | Description
736
738
---|:---:|---
737
739
<a name="operationTags"></a>tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
738
-
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
740
+
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in editing or documentation generation tools, this field SHOULD be less than 120 characters.
739
741
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
740
742
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
741
743
<a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
@@ -757,7 +759,6 @@ This object can be extended with [Specification Extensions](#specificationExtens
757
759
"pet"
758
760
],
759
761
"summary": "Updates a pet in the store with form data",
760
-
"description": "",
761
762
"operationId": "updatePetWithForm",
762
763
"parameters": [
763
764
{
@@ -819,7 +820,6 @@ This object can be extended with [Specification Extensions](#specificationExtens
819
820
tags:
820
821
- pet
821
822
summary: Updates a pet in the store with form data
822
-
description: ''
823
823
operationId: updatePetWithForm
824
824
parameters:
825
825
- name: petId
@@ -876,13 +876,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
0 commit comments