api

type Candidate struct {
	ModulePath  string `json:"modulePath"`
	PackagePath string `json:"packagePath"`
}

type Error struct {
	// Code is the HTTP status code.
	Code    int    `json:"code"`
	Message string `json:"message"`
	// Fixes are suggestions for how to fix.
	Fixes      []string    `json:"fixes"`
	Candidates []Candidate `json:"candidates,omitempty"`
	// contains filtered or unexported fields
}

type Example struct {
	Request  string
	Response string
}

type ImportedByParams struct {
	// Module path.
	Module string `form:"module"`
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	ListParams
}

type License struct {
	Types    []string `json:"types"`
	FilePath string   `json:"filePath"`
	Contents string   `json:"contents,omitempty"`
}

type ListParams struct {
	// Max number of items to return.
	Limit int `form:"limit"`
	// Where to resume listing.
	Token string `form:"token"`
	// Include only items matching the regular expression filter.
	Filter string `form:"filter"`
}

type Module struct {
	Path    string `json:"path"`
	Version string `json:"version"`
	// CommitTime is the timestamp returned by the module proxy's .info endpoint,
	// representing the time the version was created.
	CommitTime        time.Time `json:"commitTime"`
	IsLatest          bool      `json:"isLatest"`
	IsRedistributable bool      `json:"isRedistributable"`
	IsStandardLibrary bool      `json:"isStandardLibrary"`
	HasGoMod          bool      `json:"hasGoMod"`
	RepoURL           string    `json:"repoUrl"`
	GoModContents     string    `json:"goModContents,omitempty"`
	Readme            *Readme   `json:"readme,omitempty"`
	Licenses          []License `json:"licenses,omitempty"`
}

type ModuleParams struct {
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	// Whether to include licenses in the result.
	Licenses bool `form:"licenses"`
	// Whether to include the README in the result.
	Readme bool `form:"readme"`
}

type ModuleVersion struct {
	ModulePath string    `json:"modulePath"`
	Version    string    `json:"version"`
	CommitTime time.Time `json:"commitTime"`
	// IsRedistributable is whether the license allows distribution.
	IsRedistributable bool `json:"isRedistributable"`
	// HasGoMod is whether the module has a go.mod file.
	HasGoMod bool `json:"hasGoMod"`
	// LatestVersion is the latest unretracted version.
	LatestVersion     string `json:"latestVersion"`
	Deprecated        bool   `json:"deprecated"`
	DeprecationReason string `json:"deprecationReason"`
	Retracted         bool   `json:"retracted"`
	RetractionReason  string `json:"retractionReason"`
}

type Package struct {
	ModulePath        string    `json:"modulePath"`
	Version           string    `json:"version"`
	IsLatest          bool      `json:"isLatest"`
	IsStandardLibrary bool      `json:"isStandardLibrary"`
	GOOS              string    `json:"goos"`
	GOARCH            string    `json:"goarch"`
	Docs              string    `json:"docs,omitempty"`
	Imports           []string  `json:"imports,omitempty"`
	Licenses          []License `json:"licenses,omitempty"`
	PackageInfo
}

type PackageImportedBy struct {
	ModulePath string                    `json:"modulePath"`
	Version    string                    `json:"version"`
	ImportedBy PaginatedResponse[string] `json:"importedBy"`
}

type PackageInfo struct {
	Path     string `json:"path"`
	Name     string `json:"name"`
	Synopsis string `json:"synopsis"`
	// IsRedistributable is whether the license allows distribution.
	IsRedistributable bool `json:"isRedistributable"`
}

type PackageParams struct {
	// Module path.
	Module string `form:"module"`
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	// GOOS of documentation build context.
	GOOS string `form:"goos"`
	// GOARCH of documentation build context.
	GOARCH string `form:"goarch"`
	// Documentation format: text, html, md or markdown.
	// If omitted, documentation is not returned.
	Doc string `form:"doc"`
	// Whether to include examples with the returned documentation.
	Examples bool `form:"examples"`
	// Whether to include the packages that this one imports.
	Imports bool `form:"imports"`
	// Whether to include licenses in the result.
	Licenses bool `form:"licenses"`
}

type PackageSymbols struct {
	ModulePath string                    `json:"modulePath"`
	Version    string                    `json:"version"`
	Symbols    PaginatedResponse[Symbol] `json:"symbols"`
}

type PackagesParams struct {
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	ListParams
}

type PackagesResponse struct {
	ModulePath        string                         `json:"modulePath"`
	Version           string                         `json:"version"`
	IsStandardLibrary bool                           `json:"isStandardLibrary"`
	Packages          PaginatedResponse[PackageInfo] `json:"packages"`
}

type PaginatedResponse[T any] struct {
	Items         []T    `json:"items"`
	Total         int    `json:"total"`
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type PathParam struct {
	Name string
	Doc  string
}

type QueryParam struct {
	Name string
	Type string
	Doc  string
}

type Readme struct {
	Filepath string `json:"filepath"`
	Contents string `json:"contents"`
}

type RouteInfo struct {
	Route                 string
	Tags                  []string
	Summary               string
	Desc                  string
	Params                string
	Response              string
	ResponsePaginatedType string
	LinkPaginatedType     bool
	PathParams            []PathParam
	QueryParams           []QueryParam
	Examples              []*Example
}

type SearchParams struct {
	// Find packages matching this query.
	Query string `form:"q"`
	// If non-empty, find symbols matching this string.
	// The query further restricts the search to matching packages.
	Symbol string `form:"symbol"`
	ListParams
}

type SearchResult struct {
	PackagePath string `json:"packagePath"`
	ModulePath  string `json:"modulePath"`
	Version     string `json:"version"`
	Synopsis    string `json:"synopsis"`
}

type Symbol struct {
	Name string `json:"name"`
	// Kind is one of "Constant", "Variable", "Function", "Type", "Field", or "Method".
	Kind     string `json:"kind"`
	Synopsis string `json:"synopsis"`
	Parent   string `json:"parent,omitempty"`
}

type SymbolsParams struct {
	// Module path.
	Module string `form:"module"`
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	// GOOS of documentation build context.
	GOOS string `form:"goos"`
	// GOARCH of documentation build context.
	GOARCH string `form:"goarch"`
	ListParams
}

type VersionsParams struct {
	ListParams
	// Whether to include pseudo-versions in the result.
	PseudoVersions bool `form:"pseudo"`
}

type VulnParams struct {
	// Module path.
	Module string `form:"module"`
	// Module version: semantic version, 'latest', or default branches 'master' or 'main'.
	// (Latest if empty).
	Version string `form:"version"`
	ListParams
}

type Vulnerability struct {
	ID           string `json:"id"`
	Summary      string `json:"summary"`
	Details      string `json:"details"`
	FixedVersion string `json:"fixedVersion"`
}