mark body of PATCH and POST as required in generated OpenAPI specs

apigee-labs · May 24, 2016 · d8ac2ce · d8ac2ce
1 parent 6134608
commit d8ac2ce
Show file tree

Hide file tree

Showing 14 changed files with 65 additions and 2 deletions.
diff --git a/util/gen_openapispec.py b/util/gen_openapispec.py
@@ -307,7 +307,8 @@ def build_response_200():
                     {'name': 'body',
                     'in': 'body',
                     'description': body_desciption,
-                    'schema': schema
+                    'schema': schema,
+                    'required': True
                     }
                     ],
                 'responses': { 
@@ -415,7 +416,8 @@ def build_relationship_interface(self, entity_url_spec, query_path, rel_property
                     {'name': 'body',
                      'in': 'body',
                      'description': body_desciption,
-                     'schema': post_schema
+                     'schema': post_schema,
+                     'required': True
                     },
                     {'name': 'Content-Type',
                      'in': 'header',

diff --git a/util/test/gen_openapispec/dog-tracker.yaml b/util/test/gen_openapispec/dog-tracker.yaml
@@ -48,6 +48,7 @@ x-interfaces:
       - description: The subset of properties of the Dog being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Dog'
       responses:
@@ -233,6 +234,7 @@ x-interfaces:
       - description: The representation of the new Dog being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Dog'
       - description: The media type of the body
@@ -329,6 +331,7 @@ x-interfaces:
       - description: The representation of the new Person being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Person'
       - description: The media type of the body
@@ -433,6 +436,7 @@ x-interfaces:
       - description: The subset of properties of the Person being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Person'
       responses:
@@ -557,6 +561,7 @@ x-interfaces:
       - description: The representation of the new Dog being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Dog'
       - description: The media type of the body

diff --git a/util/test/gen_openapispec/hello-message.yaml b/util/test/gen_openapispec/hello-message.yaml
@@ -48,6 +48,7 @@ x-interfaces:
       - description: The subset of properties of the HelloMessage being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/HelloMessage'
       responses:

diff --git a/util/test/gen_openapispec/links-todo-list.yaml b/util/test/gen_openapispec/links-todo-list.yaml
@@ -48,6 +48,7 @@ x-interfaces:
       - description: The subset of properties of the Item being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Item'
       responses:
@@ -233,6 +234,7 @@ x-interfaces:
       - description: The representation of the new Item being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Item'
       - description: The media type of the body

diff --git a/util/test/gen_openapispec/petstore.yaml b/util/test/gen_openapispec/petstore.yaml
@@ -46,6 +46,7 @@ x-interfaces:
       - description: The representation of the Image being replaced
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Image'
       responses:
@@ -189,6 +190,7 @@ x-interfaces:
       - description: The subset of properties of the Order being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Order'
       responses:
@@ -321,6 +323,7 @@ x-interfaces:
       - description: The subset of properties of the Pet being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Pet'
       responses:
@@ -445,6 +448,7 @@ x-interfaces:
       - description: The representation of the new Image being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Image'
       - description: The media type of the body
@@ -541,6 +545,7 @@ x-interfaces:
       - description: The representation of the new Image being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Image'
       - description: The media type of the body
@@ -645,6 +650,7 @@ x-interfaces:
       - description: The subset of properties of the Session being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Session'
       responses:
@@ -777,6 +783,7 @@ x-interfaces:
       - description: The subset of properties of the Store being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Store'
       responses:
@@ -903,6 +910,7 @@ x-interfaces:
       - description: The representation of the new Session being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Login'
       - description: The media type of the body
@@ -999,6 +1007,7 @@ x-interfaces:
       - description: The representation of the new Order being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Order'
       - description: The media type of the body
@@ -1108,6 +1117,7 @@ x-interfaces:
       - description: The representation of the new Pet being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Pet'
       - description: The media type of the body
@@ -1204,6 +1214,7 @@ x-interfaces:
       - description: The representation of the new User being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/User'
       - description: The media type of the body
@@ -1308,6 +1319,7 @@ x-interfaces:
       - description: The subset of properties of the User being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/User'
       responses:

diff --git a/util/test/gen_openapispec/property-tracker.yaml b/util/test/gen_openapispec/property-tracker.yaml
@@ -48,6 +48,7 @@ x-interfaces:
       - description: The subset of properties of the Bicycle being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Bicycle'
       responses:
@@ -180,6 +181,7 @@ x-interfaces:
       - description: The subset of properties of the Dog being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Dog'
       responses:
@@ -312,6 +314,7 @@ x-interfaces:
       - description: The subset of properties of the Institution being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Institution'
       responses:
@@ -436,6 +439,7 @@ x-interfaces:
       - description: The representation of the new Dog or Bicycle being created
         in: body
         name: body
+        required: true
         schema:
           x-oneOf:
           - $ref: '#/definitions/Dog'
@@ -544,6 +548,7 @@ x-interfaces:
       - description: The subset of properties of the Person being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Person'
       responses:
@@ -668,6 +673,7 @@ x-interfaces:
       - description: The representation of the new Dog or Bicycle being created
         in: body
         name: body
+        required: true
         schema:
           x-oneOf:
           - $ref: '#/definitions/Dog'
@@ -829,6 +835,7 @@ x-interfaces:
       - description: The representation of the new Bicycle being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Bicycle'
       - description: The media type of the body
@@ -925,6 +932,7 @@ x-interfaces:
       - description: The representation of the new Dog being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Dog'
       - description: The media type of the body
@@ -1021,6 +1029,7 @@ x-interfaces:
       - description: The representation of the new Institution being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Institution'
       - description: The media type of the body
@@ -1117,6 +1126,7 @@ x-interfaces:
       - description: The representation of the new Person being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Person'
       - description: The media type of the body

diff --git a/util/test/gen_openapispec/site-webmaster.yaml b/util/test/gen_openapispec/site-webmaster.yaml
@@ -48,6 +48,7 @@ x-interfaces:
       - description: The subset of properties of the Person being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Person'
       responses:
@@ -180,6 +181,7 @@ x-interfaces:
       - description: The subset of properties of the Site being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Site'
       responses:

diff --git a/util/test/gen_openapispec/spec-hub-with-impl.yaml b/util/test/gen_openapispec/spec-hub-with-impl.yaml
@@ -67,6 +67,7 @@ x-interfaces:
       - description: The representation of the Content being replaced
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Content'
       produces:
@@ -238,6 +239,7 @@ x-interfaces:
       - description: The subset of properties of the Doc being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Doc'
       responses:
@@ -388,6 +390,7 @@ x-interfaces:
       - description: The subset of properties of the Folder being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Folder'
       responses:
@@ -554,6 +557,7 @@ x-interfaces:
       - description: The representation of the new Doc or Folder being created
         in: body
         name: body
+        required: true
         schema:
           x-oneOf:
           - $ref: '#/definitions/Doc'
@@ -674,6 +678,7 @@ x-interfaces:
       - description: The subset of properties of the Group being updated
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Group'
       responses:
@@ -985,6 +990,7 @@ x-interfaces:
       - description: The representation of the new Doc being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Doc'
       - description: The media type of the body
@@ -1117,6 +1123,7 @@ x-interfaces:
       - description: The representation of the new Folder being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Folder'
       - description: The media type of the body
@@ -1249,6 +1256,7 @@ x-interfaces:
       - description: The representation of the new Group being created
         in: body
         name: body
+        required: true
         schema:
           $ref: '#/definitions/Group'
       - description: The media type of the body