urls

Documentation

Index

• Constants
• Variables
• func Expand(argv []string) (string, error)
• func ResolveGatewayURL(optionalParsedCliFlagValue string, optionalParsedConfig *config.Config) (string, error)
• func Resources() []string
• func ValidOCMUrlAliases() []string

Constants

const (
	OCMProductionURL  = "https://api.openshift.com"
	OCMStagingURL     = "https://api.stage.openshift.com"
	OCMIntegrationURL = "https://api.integration.openshift.com"
)

const OfflineTokenPage = "https://console.redhat.com/openshift/token" // #nosec G101

OfflineTokenPage is the URL of the page used to generate offline access tokens.

Variables

var OCMURLAliases = map[string]string{
	"production":  OCMProductionURL,
	"prod":        OCMProductionURL,
	"prd":         OCMProductionURL,
	"staging":     OCMStagingURL,
	"stage":       OCMStagingURL,
	"stg":         OCMStagingURL,
	"integration": OCMIntegrationURL,
	"int":         OCMIntegrationURL,
}

Functions

func Expand

func Expand(argv []string) (string, error)

Expand returns full URI to UHC resources based on an alias. An alias allows for shortcuts on the CLI, such as replace "accts" with the full URI of the resource. Lists of resources require just the alias as a parameter, while getting/posting individual resources requires the additional ID of the resource.

func ResolveGatewayURL

func ResolveGatewayURL(optionalParsedCliFlagValue string, optionalParsedConfig *config.Config) (string, error)

URL Precedent (from highest priority to lowest priority):

1. runtime `--url` cli arg (key found in `urlAliases`)
2. runtime `--url` cli arg (non-empty string)
3. config file `URL` value (non-empty string)
4. sdk.DefaultURL

Finally, it will try to url.ParseRequestURI the resolved URL to make sure it's a valid URL.

func Resources

func Resources() []string

func ValidOCMUrlAliases

func ValidOCMUrlAliases() []string