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.

Sign up for GitHub

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

feat(vpc): generate doc/cli/sdk #532

Merged
merged 2 commits into from
Aug 28, 2020
Merged

feat(vpc): generate doc/cli/sdk #532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60a0e3b
feat(vpc): generate doc/cli/sdk
scaleway-bot Aug 28, 2020
726f4c8
Merge branch 'master' into 1.1222.0
kindermoumoute Aug 28, 2020
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
209 changes: 209 additions & 0 deletions api/instance/v1/instance_sdk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,10 @@ type CreatePlacementGroupResponse struct {
PlacementGroup *PlacementGroup `json:"placement_group"`
}

type CreatePrivateNICResponse struct {
PrivateNic *PrivateNIC `json:"private_nic"`
}

type CreateSecurityGroupResponse struct {
SecurityGroup *SecurityGroup `json:"security_group"`
}
Expand Down Expand Up @@ -711,6 +715,10 @@ type GetPlacementGroupServersResponse struct {
Servers []*PlacementGroupServer `json:"servers"`
}

type GetPrivateNICResponse struct {
PrivateNic *PrivateNIC `json:"private_nic"`
}

type GetSecurityGroupResponse struct {
SecurityGroup *SecurityGroup `json:"security_group"`
}
Expand Down Expand Up @@ -818,6 +826,10 @@ type ListPlacementGroupsResponse struct {
TotalCount uint32 `json:"total_count"`
}

type ListPrivateNICsResponse struct {
PrivateNics []*PrivateNIC `json:"private_nics"`
}

type ListSecurityGroupRulesResponse struct {
Rules []*SecurityGroupRule `json:"rules"`

Expand Down Expand Up @@ -906,6 +918,18 @@ type PlacementGroupServer struct {
PolicyRespected bool `json:"policy_respected"`
}

// PrivateNIC: private nic
type PrivateNIC struct {
// ID: the private NIC unique ID
ID string `json:"id,omitempty"`
// ServerID: the server the private NIC is attached to
ServerID string `json:"server_id,omitempty"`
// PrivateNetworkID: the private network where the private NIC is attached
PrivateNetworkID string `json:"private_network_id,omitempty"`
// MacAddress: the private NIC MAC address
MacAddress string `json:"mac_address,omitempty"`
}

// SecurityGroup: security group
type SecurityGroup struct {
// ID: the security groups' unique ID
Expand Down Expand Up @@ -1046,6 +1070,8 @@ type Server struct {
Arch Arch `json:"arch"`
// PlacementGroup: the server placement group
PlacementGroup *PlacementGroup `json:"placement_group"`
// PrivateNics: the server private NICs
PrivateNics []*PrivateNIC `json:"private_nics"`
// Zone: the zone in which is the server
Zone scw.Zone `json:"zone"`
}
Expand Down Expand Up @@ -1613,6 +1639,8 @@ type CreateServerRequest struct {
SecurityGroup *string `json:"security_group,omitempty"`
// PlacementGroup: placement group ID if server must be part of a placement group
PlacementGroup *string `json:"placement_group,omitempty"`
// PrivateNetwork: private Network IDs if the server need to be part of one or more Private Networks
PrivateNetwork []string `json:"private_network,omitempty"`
}

// createServer: create a server
Expand Down Expand Up @@ -1802,6 +1830,8 @@ type setServerRequest struct {
Arch Arch `json:"arch"`
// PlacementGroup: the server placement group
PlacementGroup *PlacementGroup `json:"placement_group"`
// PrivateNics: the server private NICs
PrivateNics []*PrivateNIC `json:"private_nics"`
}

func (s *API) setServer(req *setServerRequest, opts ...scw.RequestOption) (*setServerResponse, error) {
Expand Down Expand Up @@ -1876,6 +1906,8 @@ type UpdateServerRequest struct {
SecurityGroup *SecurityGroupTemplate `json:"security_group,omitempty"`
// PlacementGroup: placement group ID if server must be part of a placement group
PlacementGroup *NullableStringValue `json:"placement_group,omitempty"`
// PrivateNics: the server private NICs
PrivateNics []*PrivateNIC `json:"private_nics,omitempty"`
}

// updateServer: update a server
Expand Down Expand Up @@ -4340,6 +4372,183 @@ func (s *API) DeleteIP(req *DeleteIPRequest, opts ...scw.RequestOption) error {
return nil
}

type ListPrivateNICsRequest struct {
Zone scw.Zone `json:"-"`

ServerID string `json:"-"`
}

// ListPrivateNICs: list all private NICs
//
// List all private NICs of a given server.
func (s *API) ListPrivateNICs(req *ListPrivateNICsRequest, opts ...scw.RequestOption) (*ListPrivateNICsResponse, error) {
var err error

if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}

if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}

if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private_nics",
Headers: http.Header{},
}

var resp ListPrivateNICsResponse

err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}

type CreatePrivateNICRequest struct {
Zone scw.Zone `json:"-"`

ServerID string `json:"-"`

PrivateNetworkID string `json:"private_network_id,omitempty"`
}

// CreatePrivateNIC: create a private NIC connecting a server to a private network
//
// Create a private NIC connecting a server to a private network.
func (s *API) CreatePrivateNIC(req *CreatePrivateNICRequest, opts ...scw.RequestOption) (*CreatePrivateNICResponse, error) {
var err error

if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}

if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}

if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private_nics",
Headers: http.Header{},
}

err = scwReq.SetBody(req)
if err != nil {
return nil, err
}

var resp CreatePrivateNICResponse

err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}

type GetPrivateNICRequest struct {
Zone scw.Zone `json:"-"`

ServerID string `json:"-"`

PrivateNicID string `json:"-"`
}

// GetPrivateNIC: get a private NIC
//
// Get private NIC properties.
func (s *API) GetPrivateNIC(req *GetPrivateNICRequest, opts ...scw.RequestOption) (*GetPrivateNICResponse, error) {
var err error

if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}

if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}

if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}

if fmt.Sprint(req.PrivateNicID) == "" {
return nil, errors.New("field PrivateNicID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private_nics/" + fmt.Sprint(req.PrivateNicID) + "",
Headers: http.Header{},
}

var resp GetPrivateNICResponse

err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}

type DeletePrivateNICRequest struct {
Zone scw.Zone `json:"-"`

ServerID string `json:"-"`

PrivateNicID string `json:"-"`
}

// DeletePrivateNIC: delete a private NIC
//
// Delete a private NIC.
func (s *API) DeletePrivateNIC(req *DeletePrivateNICRequest, opts ...scw.RequestOption) error {
var err error

if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}

if fmt.Sprint(req.Zone) == "" {
return errors.New("field Zone cannot be empty in request")
}

if fmt.Sprint(req.ServerID) == "" {
return errors.New("field ServerID cannot be empty in request")
}

if fmt.Sprint(req.PrivateNicID) == "" {
return errors.New("field PrivateNicID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private_nics/" + fmt.Sprint(req.PrivateNicID) + "",
Headers: http.Header{},
}

err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}

type ListBootscriptsRequest struct {
Zone scw.Zone `json:"-"`

Expand Down