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
+2-26Lines changed: 2 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -145,13 +145,11 @@ By convention, the OpenAPI Specification (OAS) file is named `openapi.json` or `
145
145
Primitive data types in the OAS are based on the types supported by the [JSON-Schema Draft 4](http://json-schema.org/latest/json-schema-core.html#anchor8).
146
146
Models are described using the [Schema Object](#schemaObject) which is a subset of JSON Schema Draft 4.
147
147
148
-
An additional primitive data type `"file"` is used by the [Parameter Object](#parameterObject) and the [Response Object](#responseObject) to set the parameter type or the response as being a file.
149
-
150
148
<aname="dataTypeFormat"></a>Primitives have an optional modifier property `format`.
151
149
OAS uses several known formats to more finely define the data type being used.
152
150
However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs.
153
151
Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification.
154
-
Types that are not accompanied by a `format` property follow their definition from the JSON Schema (except for `file` type which is defined above).
152
+
Types that are not accompanied by a `format` property follow their definition from the JSON Schema.
155
153
The formats defined by the OAS are:
156
154
157
155
@@ -742,7 +740,7 @@ There are four possible parameter types.
742
740
Field Name | Type | Description
743
741
---|:---:|---
744
742
<a name="parameterName"></a>name | `string` | **Required.** The name of the parameter. Parameter names are *case sensitive*. <ul><li>If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.<li>For all other cases, the `name` corresponds to the parameter name used based on the [`in`](#parameterIn) property.</ul>
745
-
<a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path", "formData" or "cookie".
743
+
<a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path" or "cookie".
746
744
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
747
745
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
748
746
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and should be transitioned out of usage.
@@ -890,28 +888,6 @@ style: form
890
888
explode: true
891
889
```
892
890
893
-
A form data with file type for a file upload:
894
-
```json
895
-
{
896
-
"name": "avatar",
897
-
"in": "formData",
898
-
"description": "The avatar of the user",
899
-
"required": true,
900
-
"schema": {
901
-
"type": "file"
902
-
}
903
-
}
904
-
```
905
-
906
-
```yaml
907
-
name: avatar
908
-
in: formData
909
-
description: The avatar of the user
910
-
required: true
911
-
schema:
912
-
type: file
913
-
```
914
-
915
891
#### <a name="requestBodyObject"></a>Request Body Object
0 commit comments