Renamed representations to content

Author: darrelmiller

versions/3.0.md

@@ -295,7 +295,7 @@ Field Pattern | Type | Description
       "responses": {
         "200": {          
           "description": "A list of pets.",
-          "representations" : {
+          "content" : {
             "application/json" : {
               "schema": {
                 "type": "array",
@@ -319,7 +319,7 @@ Field Pattern | Type | Description
     responses:
       '200':
         description: A list of pets.
-        representations:
+        content:
           'application/json':
             schema:
               type: array
@@ -368,7 +368,7 @@ Field Pattern | Type | Description
     "responses": {
       "200": {
         "description": "pet response",
-        "representations": {
+        "content": {
           "application/json" : {
             "schema": {
               "type": "array",
@@ -381,7 +381,7 @@ Field Pattern | Type | Description
       },
       "default": {
         "description": "error payload",
-        "representations": {
+        "content": {
           "text/html" : {
             "schema": {
               "$ref": "#/definitions/ErrorModel"
@@ -415,15 +415,15 @@ get:
   responses:
     '200':
       description: pet response
-      representations:
+      content:
         'application/json':
           schema:
             type: array
             items:
               $ref: '#/definitions/Pet'
     default:
       description: error payload
-      representations:
+      content:
         'text/html':
           schema:
             $ref: '#/definitions/ErrorModel'
@@ -487,7 +487,7 @@ Field Pattern | Type | Description
     }
   ],
   "requestBody" : {
-    "representations" : {
+    "content" : {
       "application/x-www-form-urlencoded":{
         "schema" : {
           "type" : "object",
@@ -507,14 +507,14 @@ Field Pattern | Type | Description
   "responses": {
     "200": {
       "description": "Pet updated.",
-      "representations" : {
+      "content" : {
         "application/json" : {},
         "application/xml" : {}
       }
     },
     "405": {
       "description": "Invalid input",
-      "representations" : {
+      "content" : {
         "application/json" : {},
         "application/xml" : {}
       }
@@ -544,7 +544,7 @@ parameters:
   required: true
   type: string
 responseBody:
-  representations:
+  content:
     'application/x-www-form-urlencoded':
       schema:
        properties:
@@ -559,12 +559,12 @@ responseBody:
 responses:
   '200':
     description: Pet updated.
-    representations: 
+    content: 
       'application/json': {}
       'application/xml': {}
   '405':
     description: Invalid input
-    representations: 
+    content: 
       'application/json': {}
       'application/xml': {}
 security:
@@ -624,13 +624,8 @@ For complex parameter schemas, a serialization strategy is required. For all typ
 Field Name | Type | Description
 ---|:---:|---
 <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>
-<<<<<<< HEAD
-<a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path" or "cookie".
-<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use.  [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
-=======
 <a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path", "formData" or "cookie".
 <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.
->>>>>>> OpenAPI.next
 <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`. 
 <a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and should be transitioned out of usage.
 <a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
@@ -753,13 +748,11 @@ schema:
 
 Describes a single request body.
 
-The `Content-Type` of the request body must be specified by the `consumes` attribute, either at the [top-level](#oasConsumes) or [operation level](#operationConsumes).
-
 ##### Fixed Fields
 Field Name | Type | Description
 ---|:---:|---
 <a name="requestBodyDescription"></a>description | `string` | A brief description of the request body. This could contain examples of use.  [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
-<a name="requestBodyRepresentations"></a>representations | [Representations Object](#representationsObject) | The representations of the request body.
+<a name="requestBodyContent"></a>content | [Content Object](#contentObject) | The content of the request body.
 <a name="requestBodyRequired"></a>required | `boolean` | Determines if the request body is required in the request. Defaults to `true`.
 
 
@@ -775,7 +768,7 @@ A request body with a referenced model definition.
 ```js
 {
   "description": "user to add to the system",
-  "representations" : {
+  "content" : {
     "application/json" : {
       "schema": {
           "$ref": "#/definitions/User"
@@ -800,7 +793,7 @@ A request body with a referenced model definition.
 
 ```yaml
 description: user to add to the system
-representations: 
+content: 
   'application/json':
     schema:
       $ref: '#/definitions/User'
@@ -818,7 +811,7 @@ A body parameter that is an array of string values:
 ```js
 {
   "description": "user to add to the system",
-  "representations": {
+  "content": {
     "application/json" : {
       "schema": {
         "type": "array",
@@ -834,7 +827,7 @@ A body parameter that is an array of string values:
 ```yaml
 description: user to add to the system
 required: true
-representations:
+content:
   'application/json':
     schema:
       type: array
@@ -843,16 +836,16 @@ representations:
 ```
 
 
-#### <a name="representationsObject"></a>Representations Object
+#### <a name="contentObject"></a>Content Object
 
-Describes a set of supported representations.  A representations object can be used in [requestBody](#requestBody) and [response objects](#responseObject).
+Describes a set of supported content types. A content object can be used in [requestBody](#requestBody) and [response objects](#responseObject).
 
-Each key in the representations object is the media-type of the [Representation Object](#representationObject).
+Each key in the content object is the media-type of the [Content Type Object](#contentTypeObject).
 
-##### Representations Examples
+##### Content Examples
 
 ```js
-"representations" : {
+"content" : {
   "application/json": {
     "schema": {
       "type": "array",
@@ -879,7 +872,7 @@ Each key in the representations object is the media-type of the [Representation
 ```
 
 ```yaml
-representations:
+content:
   'application/json': 
     schema:
       type: array
@@ -902,23 +895,23 @@ representations:
       - "Bob,Diane,Mary,Bill"
 ```
 
-#### <a name="representationObject"></a>Representation Object
-The representation object provides schema and examples for a the media type identified by its key.  Representation objects can be used in a [representations object](#representationsObject).   
+#### <a name="contentTypeObject"></a>Content Type Object
+Each content type object provides schema and examples for a the media type identified by its key.  Content Type objects can be used in a [content object](#contentObject).   
 
 ##### Fixed Fields
 Field Name | Type | Description
 ---|:---:|---
-<a name="representationSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
-<a name="representationExamples"></a>examples | [Examples Array](#examplesArray) | Examples of the representation.
+<a name="contentTypeSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
+<a name="contentTypeExamples"></a>examples | [Examples Array](#examplesArray) | Examples of the content type.
 
 ##### Patterned Fields
 Field Pattern | Type | Description
 ---|:---:|---
 <a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
 
-##### Representation Examples
+##### Content Type Examples
 
-A representation description.
+A content type description.
 ```js
 {
   "application/json": {
@@ -1046,7 +1039,7 @@ A 200 response for successful operation and a default response for others (imply
 {
   "200": {
     "description": "a pet to be returned",
-    "representations" : {
+    "content" : {
         "application/json" : {
               "schema": {
             "$ref": "#/definitions/Pet"
@@ -1056,7 +1049,7 @@ A 200 response for successful operation and a default response for others (imply
   },
   "default": {
     "description": "Unexpected error",
-    "representations" : {
+    "content" : {
         "application/json" : {
           "schema": {
             "$ref": "#/definitions/ErrorModel"
@@ -1070,13 +1063,13 @@ A 200 response for successful operation and a default response for others (imply
 ```yaml
 '200':
   description: a pet to be returned
-  representations: 
+  content: 
     'application/json':
       schema:
         $ref: '#/definitions/Pet'
 default:
   description: Unexpected error
-  representations:
+  content:
     'application/json':
       schema:
         $ref: '#/definitions/ErrorModel'
@@ -1090,7 +1083,7 @@ Field Name | Type | Description
 ---|:---:|---
 <a name="responseDescription"></a>description | `string` | **Required.** A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
 <a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
-<a name="responseRepresentations"></a>representations | [Representations Object](#representationsObject) | An object containing descriptions of potential response payloads.
+<a name="responseRepresentations"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
 <a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
 
 
@@ -1107,7 +1100,7 @@ Response of an array of a complex type:
 ```js
 {
   "description": "A complex object array response",
-  "representations" : {
+  "content" : {
     "application/json" : {
       "schema": {
         "type": "array",
@@ -1122,7 +1115,7 @@ Response of an array of a complex type:
 
 ```yaml
 description: A complex object array response
-representations: 
+content: 
   'application/json':
     schema: 
       type: array
@@ -1135,7 +1128,7 @@ Response with a string type:
 ```js
 {
   "description": "A simple string response",
-  "representations" : {
+  "content" : {
     "application/json" : {
       "schema": {
         "type": "string"
@@ -1157,7 +1150,7 @@ Response with headers:
 ```js
 {
   "description": "A simple string response",
-  "representations" : {
+  "content" : {
     "application/json" : {
       "schema": {
         "type": "string"
@@ -1183,7 +1176,7 @@ Response with headers:
 
 ```yaml
 description: A simple string response
-representations:
+content:
   'application/json':
     schema:
       type: string
@@ -1389,7 +1382,7 @@ paths:
     responses:
       200:
         description: the user being returned
-        representations:
+        content:
           'application/json':
             schema:
               type: object
@@ -1461,7 +1454,7 @@ paths:
       responses: 
         200: 
           description: The User
-          representations:
+          content:
             'application/json': 
               schema: 
                 $ref: '#/components/definitions/user'
@@ -1479,7 +1472,7 @@ paths:
       responses:
         200:
           description: repositories owned by the supplied user
-          representations: 
+          content: 
             'application/json':
               schema:
                 type: array
@@ -1503,7 +1496,7 @@ paths:
       responses: 
         200:
           description: The repository
-            representations:
+            content:
               'application/json': 
                 schema: 
                   $ref: '#/components/definitions/repository'
@@ -1532,7 +1525,7 @@ paths:
       responses: 
         200: 
           description: an array of pull request objects
-          representations:
+          content:
             'application/json': 
               schema: 
                 type: array
@@ -1557,7 +1550,7 @@ paths:
       responses: 
         200: 
           description: a pull request object
-          representations:
+          content:
             'application/json': 
             schema: 
               $ref: '#/components/definitions/pullrequest'
@@ -1783,7 +1776,7 @@ definitions:
 
 # in a request body, note the plural `examples` as the content-type is set by `consumes`:
 	requestBody:
-      representations:
+      content:
        'application/json':
           schema:
             $ref: '#/definitions/Address'
@@ -1813,7 +1806,7 @@ definitions:
   responses:
     200:
       description: your car appointment has been booked
-      representations: 
+      content: 
         'application/json':
           schema:
             $ref: '#/definitions/SuccessResponse'