-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update group_type
enum
#78
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some notes:
@@ -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] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Moved
enum
up. - Added
home
andcouple
- Moved
apartment
andhouse
to end of list
description: What is the group used for? | ||
enum: [apartment, house, trip, other] | ||
enum: [home, trip, couple, other, apartment, house] | ||
example: "home" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Added example
description: | | ||
What is the group used for? | ||
**Note**: It is recommended to use `home` in place of `house` or `apartment`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Added Note to description
@@ -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] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Added
home
andcouple
- Moved
apartment
andhouse
to end of list
enum: [apartment, house, trip, other] | ||
example: "apartment" | ||
enum: [home, trip, couple, other, apartment, house] | ||
example: "home" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Changed example from
apartment
tohome
description: | | ||
What is the group used for? | ||
**Note**: It is recommended to use `home` in place of `house` or `apartment`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Added a description (copied from other example)
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Updated reference of
apartment
tohome
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Closes #77. Updates references to
group_type
to includehome
andcouple
. Also includes notes and updates references to preferhome
toapartment
orhouse
.