Skip to content
This repository has been archived by the owner on Jun 21, 2024. It is now read-only.

Create UserLite Struct and add CreatedBy field in Device Struct #312

Merged
merged 4 commits into from
Nov 24, 2021
Merged

Create UserLite Struct and add CreatedBy field in Device Struct #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
12013e4
Create the UserLite struct.
cprivite Nov 19, 2021
a7b6595
Add CreatedBy field to the Device struct that uses UserLite.
cprivite Nov 19, 2021
6710c5d
Use href type instead of pulling url into a string.
cprivite Nov 22, 2021
2908145
Remove URL field and improve formatting of *Href line.
cprivite Nov 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions devices.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ type Device struct {
Description *string `json:"description,omitempty"`
State string `json:"state,omitempty"`
Created string `json:"created_at,omitempty"`
CreatedBy *UserLite `json:"created_by,omitempty"`
Updated string `json:"updated_at,omitempty"`
Locked bool `json:"locked,omitempty"`
BillingCycle string `json:"billing_cycle,omitempty"`
Expand Down
15 changes: 15 additions & 0 deletions user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,21 @@ type User struct {
Staff bool `json:"staff,omitempty"`
}

// UserLite is an abbreviated listing of an Equinix Metal user
type UserLite struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's embed the Href type instead of adding the URL field. This will allow for common methods for all resources that use the Href pattern. See #269 for more details.

Suggested change
type UserLite struct {
type UserLite struct {
*Href `json:",inline"`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good to me.

Copy link
Contributor Author

@cprivitere cprivitere Nov 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Two things I'm finding.

  1. If you use this along side the URL field we have defined, whichever comes first gets the href data, and the other gets nothing and returns nil or a blank.
  2. If you do *Href first and get it populated, to use it the code looks weird:
fmt.println(device.CreatedBy.Href.Href)

Copy link
Contributor

@displague displague Nov 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

The URL field would be removed. The Href embedding will be populated.

In practice we wouldn't access Href via u.Href.Href, we would use the accessor method of the Href type, GetHref(). (this method is in the following PR: https://github.com/packethost/packngo/pull/280/files#diff-ebde46360e5c028cc3bde9d49c49bfb6038d13cd340af1d2d61845323ec284fbR59). https://go.dev/doc/effective_go#embedding has some details on the topic.

With the Href type methods proposed or discussed in that PR (SetHref GetHref), we will be able to fill in some gaps/inconsistencies of the API.

An example of these inconsistencies:
When an object returns {field: {href:"/field/id"}, we can use ?include=field to return that nested object.
However, the object returned in field may (or may not, this is inconsistent) omit the href field. The experience around .Href will change based on query parameters. We can heal this with a GetHref that could rebuild the URL based on the ID. Likewise, we can offer .GetID() based on the basename of the path in the Href field when the child object was not ?include'd.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, since I'm assuming we don't want to break User.URL as part of this PR, we'll just do this methodology in UserLite as it's new.

*Href `json:",inline"`
ID string `json:"id"`
ShortID string `json:"short_id"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
FullName string `json:"full_name,omitempty"`
Email string `json:"email,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
Level string `json:"level,omitempty"`
AvatarThumbURL string `json:"avatar_thumb_url,omitempty"`
}

// UserUpdateRequest struct for UserService.Update
type UserUpdateRequest struct {
FirstName *string `json:"first_name,omitempty"`
Expand Down