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
This updates the ToC through the [Info Object](#infoObject) and its children to use the internal anchors in the document (instead of GitHub-generated anchors)
Signed-off-by: Rob Dolin <[email protected]>
3.0.0-rc0 | 2017-02-28 | Implementor's draft of the 3.0 specification
74
-
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
75
-
2.0 | 2014-09-08 | Release of Swagger 2.0
76
-
1.2 | 2014-03-14 | Initial release of the formal document.
77
-
1.1 | 2012-08-22 | Release of Swagger 1.1
78
-
1.0 | 2011-08-10 | First release of the Swagger Specification
79
-
80
72
## Definitions
81
73
82
74
##### <aname="pathTemplating"></a>Path Templating
@@ -130,15 +122,15 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
130
122
- Tags MUST be limited to those allowed by the [JSON Schema ruleset](http://www.yaml.org/spec/1.2/spec.html#id2803231)
131
123
- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](http://yaml.org/spec/1.2/spec.html#id2802346)
132
124
133
-
### File Structure
125
+
### <aname="fileStructure"></a>File Structure
134
126
135
127
The OAS representation of the API is made of a single file.
136
128
However, parts of the definitions can be split into separate files, at the discretion of the user.
137
129
This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions.
138
130
139
131
By convention, the OpenAPI Specification (OAS) file is named `openapi.json` or `openapi.yaml`.
140
132
141
-
### Data Types
133
+
### <aname="dataTypes"></a>Data Types
142
134
143
135
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.
144
136
Models are described using the [Schema Object](#schemaObject) which is an extended subset of JSON Schema Specification Wright Draft 00.
@@ -3550,3 +3542,14 @@ Two examples for this:
3550
3542
3551
3543
1. The [Paths Object](#pathsObject) MAY be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They'd still have access to the [Info Object](#infoObject) which may contain additional information regarding authentication.
3552
3544
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 than hiding the path itself from the [Paths Object](#pathsObject) so the user will not be aware of its existence. This allows the documentation provider a finer control over what the viewer can see.
3545
+
3546
+
## <a name="revisionHistory"></a>Appendix A: Revision History
3547
+
3548
+
Version | Date | Notes
3549
+
--- | --- | ---
3550
+
3.0.0-rc0 | 2017-02-28 | Implementor's draft of the 3.0 specification
3551
+
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
3552
+
2.0 | 2014-09-08 | Release of Swagger 2.0
3553
+
1.2 | 2014-03-14 | Initial release of the formal document.
3554
+
1.1 | 2012-08-22 | Release of Swagger 1.1
3555
+
1.0 | 2011-08-10 | First release of the Swagger Specification
0 commit comments