chore: rename field for update requests [APIGW-1505] (#256)

Author: loicbourgois

api/instance/v1/instance_sdk.go

@@ -4007,8 +4007,8 @@ func (s *API) setIP(req *SetIPRequest, opts ...scw.RequestOption) (*setIPRespons
 
 type updateIPRequest struct {
 	Zone scw.Zone `json:"-"`
-
-	IPID string `json:"-"`
+	// IP iP ID or IP address
+	IP string `json:"-"`
 
 	Reverse *NullableStringValue `json:"reverse,omitempty"`
 
@@ -4028,13 +4028,13 @@ func (s *API) updateIP(req *updateIPRequest, opts ...scw.RequestOption) (*Update
 		return nil, errors.New("field Zone cannot be empty in request")
 	}
 
-	if fmt.Sprint(req.IPID) == "" {
-		return nil, errors.New("field IPID cannot be empty in request")
+	if fmt.Sprint(req.IP) == "" {
+		return nil, errors.New("field IP cannot be empty in request")
 	}
 
 	scwReq := &scw.ScalewayRequest{
 		Method:  "PATCH",
-		Path:    "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/ips/" + fmt.Sprint(req.IPID) + "",
+		Path:    "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/ips/" + fmt.Sprint(req.IP) + "",
 		Headers: http.Header{},
 	}
 

api/instance/v1/instance_utils.go

@@ -29,7 +29,7 @@ func lockServer(zone scw.Zone, serverID string) *sync.Mutex {
 // AttachIPRequest contains the parameters to attach an IP to a server
 type AttachIPRequest struct {
 	Zone     scw.Zone `json:"-"`
-	IPID     string   `json:"-"`
+	IP       string   `json:"-"`
 	ServerID string   `json:"server_id"`
 }
 
@@ -42,7 +42,7 @@ type AttachIPResponse struct {
 func (s *API) AttachIP(req *AttachIPRequest, opts ...scw.RequestOption) (*AttachIPResponse, error) {
 	ipResponse, err := s.updateIP(&updateIPRequest{
 		Zone:   req.Zone,
-		IPID:   req.IPID,
+		IP:     req.IP,
 		Server: &NullableStringValue{Value: req.ServerID},
 	})
 	if err != nil {
@@ -55,7 +55,7 @@ func (s *API) AttachIP(req *AttachIPRequest, opts ...scw.RequestOption) (*Attach
 // DetachIPRequest contains the parameters to detach an IP from a server
 type DetachIPRequest struct {
 	Zone scw.Zone `json:"-"`
-	IPID string   `json:"-"`
+	IP   string   `json:"-"`
 }
 
 // DetachIPResponse contains the updated IP after detaching
@@ -67,7 +67,7 @@ type DetachIPResponse struct {
 func (s *API) DetachIP(req *DetachIPRequest, opts ...scw.RequestOption) (*DetachIPResponse, error) {
 	ipResponse, err := s.updateIP(&updateIPRequest{
 		Zone:   req.Zone,
-		IPID:   req.IPID,
+		IP:     req.IP,
 		Server: &NullableStringValue{Null: true},
 	})
 	if err != nil {
@@ -81,15 +81,15 @@ func (s *API) DetachIP(req *DetachIPRequest, opts ...scw.RequestOption) (*Detach
 // if Reverse is an empty string, the reverse will be removed
 type UpdateIPRequest struct {
 	Zone    scw.Zone             `json:"-"`
-	IPID    string               `json:"-"`
+	IP      string               `json:"-"`
 	Reverse *NullableStringValue `json:"reverse"`
 }
 
 // UpdateIP updates an IP
 func (s *API) UpdateIP(req *UpdateIPRequest, opts ...scw.RequestOption) (*UpdateIPResponse, error) {
 	ipResponse, err := s.updateIP(&updateIPRequest{
 		Zone:    req.Zone,
-		IPID:    req.IPID,
+		IP:      req.IP,
 		Reverse: req.Reverse,
 	})
 	if err != nil {

api/instance/v1/instance_utils_test.go

@@ -55,7 +55,7 @@ func TestInstanceHelpers(t *testing.T) {
 
 		// Attach IP
 		ipAttachResponse, err := instanceAPI.AttachIP(&AttachIPRequest{
-			IPID:     ipID,
+			IP:       ipID,
 			Zone:     zone,
 			ServerID: serverID,
 		})
@@ -65,7 +65,7 @@ func TestInstanceHelpers(t *testing.T) {
 
 		// Detach IP
 		ipDetachResponse, err := instanceAPI.DetachIP(&DetachIPRequest{
-			IPID: ipID,
+			IP:   ipID,
 			Zone: zone,
 		})
 
@@ -74,7 +74,7 @@ func TestInstanceHelpers(t *testing.T) {
 
 		// Set reverse
 		ipSetReverseResponse, err := instanceAPI.UpdateIP(&UpdateIPRequest{
-			IPID:    ipID,
+			IP:      ipID,
 			Zone:    zone,
 			Reverse: reverse,
 		})
@@ -83,7 +83,7 @@ func TestInstanceHelpers(t *testing.T) {
 
 		// Omitempty reverse
 		ipSetReverseResponse, err = instanceAPI.UpdateIP(&UpdateIPRequest{
-			IPID:    ipID,
+			IP:      ipID,
 			Zone:    zone,
 			Reverse: nil,
 		})
@@ -92,7 +92,7 @@ func TestInstanceHelpers(t *testing.T) {
 
 		// Unset reverse
 		ipDeleteReverseResponse, err := instanceAPI.UpdateIP(&UpdateIPRequest{
-			IPID:    ipID,
+			IP:      ipID,
 			Zone:    zone,
 			Reverse: nullReverse,
 		})