dashboard

Documentation

Index

• Variables
• type APIResponse
• type APISResponse
• type CategoriesPayload
• type Client
  • func NewDashboardClient(url, secret, orgID string, allowUnsafeOAS bool) (*Client, error)
  • func (c *Client) CreateAPIs(apiDefs *[]objects.DBApiDefinition) error
  • func (c *Client) CreateAssets(assetsDefs *[]objects.DBAssets) error
  • func (c *Client) CreateCertificate(cert []byte) (string, error)
  • func (c *Client) CreatePolicies(pols *[]objects.Policy) error
  • func (c *Client) DeleteAPI(id string) error
  • func (c *Client) DeleteAssets(id string) error
  • func (c *Client) DeletePolicy(id string) error
  • func (c *Client) FetchAPI(apiID string) (objects.DBApiDefinition, error)
  • func (c *Client) FetchAPIs() (*APISResponse, error)
  • func (c *Client) FetchAsset(assetID string) (objects.DBAssets, error)
  • func (c *Client) FetchAssets() ([]objects.DBAssets, error)
  • func (c *Client) FetchOASAPI(id string) (*oas.OAS, error)
  • func (c *Client) FetchOASCategory(id string) ([]string, error)
  • func (c *Client) FetchPolicies() ([]objects.Policy, error)
  • func (c *Client) FetchPolicy(id string) (*objects.Policy, error)
  • func (c *Client) GetActiveID(def *objects.DBApiDefinition) string
  • func (c *Client) SetInsecureTLS(val bool)
  • func (c *Client) SyncAPIs(apiDefs []objects.DBApiDefinition) error
  • func (c *Client) SyncAssets(assetsDefs []objects.DBAssets) error
  • func (c *Client) SyncPolicies(pols []objects.Policy) error
  • func (c *Client) UpdateAPIs(apiDefs *[]objects.DBApiDefinition) error
  • func (c *Client) UpdateAssets(assetsDef *[]objects.DBAssets) error
  • func (c *Client) UpdateOASCategory(oasApi *objects.DBApiDefinition) (*grequests.Response, error)
  • func (c *Client) UpdatePolicies(pols *[]objects.Policy) error
• type PoliciesData

Variables

var (
	UseUpdateError      error = errors.New("Object seems to exist (same ID, API ID, Listen Path or Slug), use update()")
	UsePolUpdateError   error = errors.New("Object seems to exist (same ID, Explicit ID), use update()")
	UseCreateError      error = errors.New("Object does not exist, use create()")
	UseAssetUpdateError error = errors.New("Object seems to exist (same ID) use update()")
)

Types

type APIResponse

type APIResponse struct {
	Message string
	Meta    string
	Status  string
}

type APISResponse

type APISResponse struct {
	Apis  []objects.DBApiDefinition `json:"apis"`
	Pages int                       `json:"pages"`
}

type CategoriesPayload

type CategoriesPayload struct {
	Categories []string `json:"categories"`
}

CategoriesPayload is a struct that holds a list of categories.

type Client

type Client struct {
	InsecureSkipVerify bool
	OrgID              string
	// contains filtered or unexported fields
}

func NewDashboardClient

func NewDashboardClient(url, secret, orgID string, allowUnsafeOAS bool) (*Client, error)

func (*Client) CreateAPIs

func (c *Client) CreateAPIs(apiDefs *[]objects.DBApiDefinition) error

func (*Client) CreateAssets

func (c *Client) CreateAssets(assetsDefs *[]objects.DBAssets) error

func (*Client) CreateCertificate

func (c *Client) CreateCertificate(cert []byte) (string, error)

func (*Client) CreatePolicies

func (c *Client) CreatePolicies(pols *[]objects.Policy) error

func (*Client) DeleteAPI

func (c *Client) DeleteAPI(id string) error

func (*Client) DeleteAssets

func (c *Client) DeleteAssets(id string) error

func (*Client) DeletePolicy

func (c *Client) DeletePolicy(id string) error

func (*Client) FetchAPI

func (c *Client) FetchAPI(apiID string) (objects.DBApiDefinition, error)

func (*Client) FetchAPIs

func (c *Client) FetchAPIs() (*APISResponse, error)

func (*Client) FetchAsset

func (c *Client) FetchAsset(assetID string) (objects.DBAssets, error)

func (*Client) FetchAssets

func (c *Client) FetchAssets() ([]objects.DBAssets, error)

func (*Client) FetchOASAPI

func (c *Client) FetchOASAPI(id string) (*oas.OAS, error)

func (*Client) FetchOASCategory

func (c *Client) FetchOASCategory(id string) ([]string, error)

func (*Client) FetchPolicies

func (c *Client) FetchPolicies() ([]objects.Policy, error)

func (*Client) FetchPolicy

func (c *Client) FetchPolicy(id string) (*objects.Policy, error)

func (*Client) GetActiveID

func (c *Client) GetActiveID(def *objects.DBApiDefinition) string

func (*Client) SetInsecureTLS

func (c *Client) SetInsecureTLS(val bool)

func (*Client) SyncAPIs

func (c *Client) SyncAPIs(apiDefs []objects.DBApiDefinition) error

func (*Client) SyncAssets

func (c *Client) SyncAssets(assetsDefs []objects.DBAssets) error

func (*Client) SyncPolicies

func (c *Client) SyncPolicies(pols []objects.Policy) error

func (*Client) UpdateAPIs

func (c *Client) UpdateAPIs(apiDefs *[]objects.DBApiDefinition) error

func (*Client) UpdateAssets

func (c *Client) UpdateAssets(assetsDef *[]objects.DBAssets) error

func (*Client) UpdateOASCategory

func (c *Client) UpdateOASCategory(oasApi *objects.DBApiDefinition) (*grequests.Response, error)

func (*Client) UpdatePolicies

func (c *Client) UpdatePolicies(pols *[]objects.Policy) error

type PoliciesData

type PoliciesData struct {
	Data  []objects.Policy
	Pages int
}