valist

README

Valist Go SDK.

Documentation

Documentation for how to get started with Valist can be found at https://docs.valist.io.

Building

System Requirements:

• go >= 1.16

git clone https://github.com/valist-io/valist-go

cd valist-go

go build .

Contributing

We welcome pull requests and would love to support our early contributors with some awesome perks!

Found a bug or have an idea for a feature? Create an issue.

Maintainers

@awantoch

@jiyuu-jin

@nasdf

License

Valist is licensed under the Mozilla Public License Version 2.0.

Documentation

Index

• type AccountMeta
• type GalleryItem
• type ProjectMeta
• type ReleaseMeta

Types

type AccountMeta

type AccountMeta struct {
	// Image is the URI of the team image
	Image string `json:"image"`
	// Name is the team friendly name.
	Name string `json:"name"`
	// Description is a short description of the team.
	Description string `json:"description"`
	// ExternalURL is a link to the team website.
	ExternalURL string `json:"external_url"`
}

type GalleryItem

type GalleryItem struct {
	Name    string `json:"name"`
	Src     string `json:"src"`
	Type    string `json:"type"`
	Preview string `json:"preview"`
}

type ProjectMeta

type ProjectMeta struct {
	// Image is the URI of the project image
	Image string `json:"image"`
	// Name is the project friendly name.
	Name string `json:"name"`
	// ShortDescription is a short description of the project.
	ShortDescription string `json:"short_description"`
	// Description is a description of the project.
	Description string `json:"description"`
	// ExternalURL is a link to the project website.
	ExternalURL string `json:"external_url"`
	// Type is the project type.
	Type string `json:"type"`
	// Tags is a list of keywords.
	Tags []string `json:"tags"`
	// Gallery contains a list of items for the gallery.
	Gallery []GalleryItem `json:"gallery"`
}

type ReleaseMeta

type ReleaseMeta struct {
	// Image is the URI of the release image
	Image string `json:"image"`
	// Name is the unique release name.
	Name string `json:"name"`
	// Description is a description of the release.
	Description string `json:"description"`
	// ExternalURL is a link to the release assets.
	ExternalURL string `json:"external_url"`
}