api

Documentation

Index

• Variables
• func GetV2ID(forV1Api API) string
• type API
  • func (a API) CreateURL(environmentURL string) string
  • func (a API) IsStandardAPI() bool
• type APIs
  • func NewAPIs() APIs
  • func NewV1APIs() APIs
  • func (apis APIs) Contains(api string) bool
  • func (apis APIs) Filter(filters ...Filter) APIs
  • func (apis APIs) GetApiNameLookup() map[string]struct{}
  • func (apis APIs) GetNames() []string
• type Filter
  • func RetainByName(apis []string) Filter

Variables

var StandardApiPropertyNameOfGetAllResponse = "values"

Functions

func GetV2ID

func GetV2ID(forV1Api API) string

GetV2ID returns the ID of APIs in v2 - replacing deprecated APIs with their new version and dropping the -v2 marker from APIs introducing the breaking change of handling non-unique-names. This is used in v1 -> v2 conversion

Types

type API

type API struct {
	ID                           string
	URLPath                      string
	PropertyNameOfGetAllResponse string
	// SingleConfiguration are those APIs that configure an environment global setting.
	// Such settings require additional handling and can't be deleted.
	SingleConfiguration bool
	// NonUniqueName name APIs are those APIs that don't work with an environment wide unique ID.
	// For such APIs, the name attribute can't be used as a ID (Monaco default behavior), hence
	// such APIs require additional handling.
	NonUniqueName bool
	DeprecatedBy  string
	// SkipDownload indicates whether an API should be downloaded or not.
	//
	// Some APIs are not re-uploadable by design, either as they require hidden credentials,
	// or if they require a special format, e.g. a zip file.
	//
	// Those configs include all configs handling credentials, as well as the extension-API.
	SkipDownload bool
}

API structure present definition of config endpoints

func (API) CreateURL

func (a API) CreateURL(environmentURL string) string

CreateURL creates final URL for given environmentUrl/domain

func (API) IsStandardAPI

func (a API) IsStandardAPI() bool

type APIs

type APIs map[string]API

APIs is a collection of API

func NewAPIs

func NewAPIs() APIs

NewAPIs returns collection of predefined API to work with Dynatrace

func NewV1APIs

func NewV1APIs() APIs

NewV1APIs returns collection of predefined API to work with Dynatrace Deprecated: Please use NewAPIs. This one is legacy and is used only to convert old to new stype of

func (APIs) Contains

func (apis APIs) Contains(api string) bool

Contains return true iff requested API is part APIs set

func (APIs) Filter

func (apis APIs) Filter(filters ...Filter) APIs

Filter apply all passed filters and return new filtered array

func (APIs) GetApiNameLookup

func (apis APIs) GetApiNameLookup() map[string]struct{}

func (APIs) GetNames

func (apis APIs) GetNames() []string

GetNames return names of API contained by this structure

type Filter

type Filter func(api API) bool

Filter return true iff specific api needs to be filtered/ removed from list

func RetainByName

func RetainByName(apis []string) Filter

RetainByName creates a Filter that leaves the API in the map if API.ID is part of the provided list. If the provided list is empty, a no-op filter is returned.