Merge pull request #63 from splitwise/fix-spec-issues

Fix spec issues

Author: jas14

docs/index.html

@@ -59,12 +59,14 @@ post:
                 type: object
                 additionalProperties:
                   type: array
+                  items:
+                    type: string
           examples:
             Success:
               value:
                 success: true
                 user: {}
-                errors: []
+                errors: {}
             Failure:
               value:
                 success: false

paths/add_user_to_group.yaml

@@ -39,8 +39,11 @@ post:
                   - "$ref": "../schemas/friend.yaml"
                   - title: User
               errors:
-                type: array
-                example: []
+                type: object
+                additionalProperties:
+                  type: array
+                  items:
+                    type: string
     '400':
       description: Bad Request
       content:
@@ -50,18 +53,24 @@ post:
             properties:
               users:
                 type: array
+                items:
+                  allOf:
+                  - "$ref": "../schemas/friend.yaml"
+                  - title: User
                 example: []
               errors:
                 type: object
                 additionalProperties:
                   type: array
+                  items:
+                    type: string
                 example:
                   base:
                   - Please supply a name for this user
-        example:
-          users: []
-          errors:
-            base:
-            - That user cannot be a member of this group
+            example:
+              users: []
+              errors:
+                base:
+                - That user cannot be a member of this group
     '401':
       "$ref": "../responses/unauthorized.yaml"

paths/create_friends.yaml

@@ -1,6 +1,6 @@
 ---
 post:
-  params:
+  parameters:
   - in: path
     name: id
     schema:

paths/delete_comment.yaml

@@ -1,26 +1,31 @@
 ---
-params:
-- in: query
-  name: id
-  description: ID of the expense to delete
 post:
   tags:
   - expenses
   summary: Delete an expense
   description: "**Note**: 200 OK does not indicate a successful response. The operation
     was successful only if `success` is true.\n"
+  parameters:
+  - in: path
+    name: id
+    description: ID of the expense to delete
+    schema:
+      type: integer
+    required: true
   responses:
     '200':
+      description: OK
       content:
         application/json:
           schema:
             type: object
             properties:
               success:
                 type: boolean
-                required: true
               errors:
                 type: object
+            required:
+              - success
           examples:
             Success:
               value:

paths/delete_expense.yaml

@@ -1,11 +1,4 @@
 ---
-parameters:
-- in: path
-  name: id
-  description: User ID of the friend
-  schema:
-    type: integer
-  required: true
 post:
   tags:
   - friends
@@ -14,6 +7,13 @@ post:
     Given a friend ID, break off the friendship between the current user and the specified user.
 
     **Note**: 200 OK does not indicate a successful response. You must check the `success` value of the response.
+  parameters:
+  - in: path
+    name: id
+    description: User ID of the friend
+    schema:
+      type: integer
+    required: true
   responses:
     '200':
       description: OK
@@ -28,6 +28,8 @@ post:
                 type: object
                 additionalProperties:
                   type: array
+                  items:
+                    type: string
           examples:
             Success:
               value:

paths/delete_friend.yaml

@@ -47,7 +47,7 @@
   $ref: ./get_comments.yaml
 /create_comment:
   $ref: ./create_comment.yaml
-/delete_comment:
+/delete_comment/{id}:
   $ref: ./delete_comment.yaml
 /get_notifications:
   $ref: ./get_notifications.yaml

paths/index.yaml

@@ -20,7 +20,6 @@ post:
             properties:
               input:
                 type: string
-                required: true
                 example: "I owe Ada 5 bucks"
                 description: A natural language sentence describing an expense.
               autosave:
@@ -32,7 +31,6 @@ post:
             properties:
               input:
                 type: string
-                required: true
                 example: "I owe Ada 5 bucks"
                 description: A natural language sentence describing an expense.
               friend_id:
@@ -46,7 +44,6 @@ post:
             properties:
               input:
                 type: string
-                required: true
                 example: "I owe Ada 5 bucks"
                 description: A natural language sentence describing an expense.
               group_id:

paths/parse_sentence.yaml

@@ -37,11 +37,13 @@ post:
                 type: object
                 additionalProperties:
                   type: array
+                  items:
+                    type: string
           examples:
             Success:
               value:
                 success: true
-                errors: []
+                errors: {}
             Failure:
               value:
                 success: false

paths/remove_user_from_group.yaml

@@ -1,16 +1,20 @@
 ---
-params:
-- in: query
-  name: id
-  description: ID of the expense to restore
 post:
   tags:
   - expenses
   summary: Restore an expense
   description: "**Note**: 200 OK does not indicate a successful response. The operation
     was successful only if `success` is true.\n"
+  parameters:
+  - in: path
+    name: id
+    description: ID of the expense to restore
+    schema:
+      type: integer
+    required: true
   responses:
     '200':
+      description: OK
       content:
         application/json:
           schema: