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

feat(instance): add documentation on ListSnapshotsRequest #1845

Merged
merged 1 commit into from
Sep 20, 2023
Merged
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions api/instance/v1/instance_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2930,19 +2930,19 @@ func (s *API) DeleteImage(req *DeleteImageRequest, opts ...scw.RequestOption) er
type ListSnapshotsRequest struct {
// Zone: zone to target. If none is passed will use default zone from the config.
Zone scw.Zone `json:"-"`

// Organization: list snapshots only for this Organization ID.
Organization *string `json:"-"`

// Project: list snapshots only for this Project ID.
Project *string `json:"-"`
// PerPage: number of snapshots returned per page (positive integer lower or equal to 100).
PerPage *uint32 `json:"-"`

// Page: page to be returned.
Page *int32 `json:"-"`

// Name: list snapshots of the requested name.
Name *string `json:"-"`

Project *string `json:"-"`

// Tags: list snapshots that have the requested tag.
Tags *string `json:"-"`

// BaseVolumeID: list snapshots originating only from this volume.
BaseVolumeID *string `json:"-"`
}

Expand All @@ -2963,10 +2963,10 @@ func (s *API) ListSnapshots(req *ListSnapshotsRequest, opts ...scw.RequestOption

query := url.Values{}
parameter.AddToQuery(query, "organization", req.Organization)
parameter.AddToQuery(query, "project", req.Project)
parameter.AddToQuery(query, "per_page", req.PerPage)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "name", req.Name)
parameter.AddToQuery(query, "project", req.Project)
parameter.AddToQuery(query, "tags", req.Tags)
parameter.AddToQuery(query, "base_volume_id", req.BaseVolumeID)

Expand Down
Loading