Skip to content
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

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Conversation

dylanrainwater
Copy link
Contributor

Closes #77. Updates references to group_type to include home and couple. Also includes notes and updates references to prefer home to apartment or house.

Copy link
Contributor Author

@dylanrainwater dylanrainwater left a 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]
Copy link
Contributor Author

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 and couple
  • Moved apartment and house 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"
Copy link
Contributor Author

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`.
Copy link
Contributor Author

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]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Added home and couple
  • Moved apartment and house to end of list

enum: [apartment, house, trip, other]
example: "apartment"
enum: [home, trip, couple, other, apartment, house]
example: "home"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Changed example from apartment to home

description: |
What is the group used for?
**Note**: It is recommended to use `home` in place of `house` or `apartment`.
Copy link
Contributor Author

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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Updated reference of apartment to home

Copy link
Collaborator

@jas14 jas14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@dylanrainwater dylanrainwater merged commit 34e45cf into main Dec 21, 2023
@jas14 jas14 deleted the dylan/77/update-group_type-enum branch December 21, 2023 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update specification for group_types
2 participants