Merge pull request #78 from splitwise/dylan/77/update-group_type-enum

Update `group_type` enum

paths/create_group.yaml

@@ -19,8 +19,12 @@ post:
               type: string
             group_type:
               type: string
-              description: What is the group used for?
-              enum: [apartment, house, trip, other]
+              enum: [home, trip, couple, other, apartment, house]
+              example: "home"
+              description: |
+                What is the group used for?
+
+                **Note**: It is recommended to use `home` in place of `house` or `apartment`.
             simplify_by_default:
               type: boolean
               description: Turn on simplify debts?

schemas/group.yaml

@@ -8,8 +8,12 @@ properties:
     example: "Housemates 2020"
   group_type:
     type: string
-    enum: [apartment, house, trip, other]
-    example: "apartment"
+    enum: [home, trip, couple, other, apartment, house]
+    example: "home"
+    description: |
+      What is the group used for?
+
+      **Note**: It is recommended to use `home` in place of `house` or `apartment`.
   updated_at:
     type: string
     format: date-time

splitwise.yaml

@@ -277,7 +277,7 @@ tags:
   - name: groups
     x-displayName: Groups
     description:
-      A Group represents a collection of users who share expenses together. For example, some users use a Group to aggregate expenses related to an apartment. Others use it to represent a trip.
+      A Group represents a collection of users who share expenses together. For example, some users use a Group to aggregate expenses related to a home. Others use it to represent a trip.
       Expenses assigned to a group are split among the users of that group.
       Importantly, two users in a Group can also have expenses with one another outside of the Group.
   - name: friends