pkg

Documentation

Index

• Constants
• func Server()
• type Input
• type Meta
• type Module
• type Output
• type Provider
• type Request
• type Resource
• type Response
• type Root
• type Submodule
• type Version

Constants

const VERSION = "0.0.1"

VERSION format is loosely based on [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Functions

func Server

func Server()

Server ...

Types

type Input

type Input struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Default     string `json:"default"`
}

Input ...

type Meta

type Meta struct {
	Limit         int    `json:"limit"`
	CurrentOffset int    `json:"current_offset"`
	NextOffset    int    `json:"next_offset"`
	NextURL       string `json:"next_url"`
}

Meta ...

type Module

type Module struct {
	ID          string `json:"id"`
	Owner       string `json:"owner"`
	Namespace   string `json:"namespace"`
	Name        string `json:"name"`
	Version     string `json:"version"`
	Provider    string `json:"provider"`
	Description string `json:"description"`
	Source      string `json:"source"`
	Published   string `json:"published_at"`
	Downloads   int    `json:"downloads"`
	Verified    bool   `json:"verified"`
	Root        Root

	Versions []Version `json:"versions"`
}

Module ...

type Output

type Output struct {
	Name        string `json:"name"`
	Description string `json:"descripiton"`
}

Output ...

type Provider

type Provider struct {
	Name    string `json:"name"`
	Version string `json:"verstion"`
}

Provider ...

type Request

type Request struct{}

Request ...

type Resource

type Resource struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

Resource ...

type Response

type Response struct {
	Meta    Meta
	Modules []Module
	Errors  []string `json:"errors"`
}

Response ...

type Root

type Root struct {
	Path         string     `json:"path"`
	Readme       string     `json:"readme"`
	Empty        bool       `json:"empty"`
	Inputs       []Input    `json:"inputs"`
	Outputs      []Output   `json:"outputs"`
	Dependencies []string   `json:"dependencies"`
	Resources    []Resource `json:"resources"`
}

Root ...

type Submodule

type Submodule struct {
	Path      string     `json:"path"`
	Providers []Provider `json:"providers"`
}

Submodule ..

type Version

type Version struct {
	Version    string      `json:"version"`
	Submodules []Submodule `json:"submodules"`
	Root       struct {
		Dependencies []string   `json:"dependencies"`
		Providers    []Provider `json:"providers"`
	}
}

Version ...