uritemplates

Documentation

Overview

Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).

To use uritemplates, parse a template string and expand it with a value map:

template, _ := uritemplates.Parse("https://api.github.com/repos{/user,repo}")
values := make(map[string]interface{})
values["user"] = "jtacoma"
values["repo"] = "uritemplates"
expanded, _ := template.Expand(values)
fmt.Printf(expanded)

Index

• Constants
• type URITemplateCache
  • func NewUriTemplateCache() *URITemplateCache
  • func (c *URITemplateCache) Expand(uriTemplate string, value any) (string, error)
  • func (c *URITemplateCache) ExpandLinked(resource *resources.Resource, linkKey string, value any) (string, error)
  • func (c *URITemplateCache) Intern(uriTemplate string) (*UriTemplate, error)
• type UriTemplate
  • func Parse(rawtemplate string) (template *UriTemplate, err error)
  • func (self *UriTemplate) Expand(value interface{}) (string, error)
  • func (self *UriTemplate) Names() []string
  • func (t UriTemplate) String() string

Constants

const (
	BuildInformation                    = "/api/{spaceId}/build-information{/id}{?packageId,filter,latest,skip,take,overwriteMode}"
	BuildInformationBulk                = "/api/{spaceId}/build-information/bulk{?ids}"
	CreateReleaseCommandV1              = "/api/{spaceId}/releases/create/v1"                       // POST
	CreateDeploymentTenantedCommandV1   = "/api/{spaceId}/deployments/create/tenanted/v1"           // POST
	CreateDeploymentUntenantedCommandV1 = "/api/{spaceId}/deployments/create/untenanted/v1"         // POST
	CreateRunRunbookCommand             = "/api/{spaceId}/runbook-runs/create/v1"                   // POST
	DeploymentProcesses                 = "/api/{spaceId}/deploymentprocesses{/id}{?skip,take,ids}" // GET
	FeedSearchPackageVersions           = ""                                                        // GET
	/* 141-byte string literal not displayed */
	Packages                    = "/api/{spaceId}/packages{/id}{?nuGetPackageId,filter,latest,skip,take,includeNotes}"                                // GET
	PackageUpload               = "/api/{spaceId}/packages/raw{?replace,overwriteMode}"                                                               // POST multipart form
	ReleaseDeploymentPreview    = "/api/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}{?includeDisabledSteps}"                    // GET
	Releases                    = "/api/{spaceId}/releases{/id}{?skip,ignoreChannelRules,take,ids}"                                                   // GET
	ReleasesByProject           = "/api/{spaceId}/projects/{projectId}/releases{/version}{?skip,take,searchByVersion}"                                // GET
	ReleasesByProjectAndChannel = "/api/{spaceId}/projects/{projectId}/channels/{channelId}/releases{?skip,take,searchByVersion}"                     // GET
	Runbooks                    = "/api/{spaceId}/runbooks{/id}{?skip,take,ids,partialName,clone,projectIds}"                                         // GET
	RunbooksByProject           = "/api/{spaceId}/projects/{projectId}/runbooks{?skip,take,partialName}"                                              // GET
	RunbookEnvironments         = "/api/{spaceId}/projects/{projectId}/runbooks/{runbookId}/environments"                                             // GET
	RunbookProcess              = "/api/{spaceId}/projects/{projectId}/runbookProcesses/{id}"                                                         // GET
	RunbookRunPreview           = "/api/{spaceId}/projects/{projectId}/runbooks/{runbookId}/runbookRuns/preview/{environment}{?includeDisabledSteps}" // GET
	RunbookSnapshotsByRunbook   = "/api/{spaceId}/projects/{projectId}/runbooks/{runbookId}/runbookSnapshots{/name}{?skip,take,searchByName}"         // GET
	RunbookSnapshotsByProject   = "/api/{spaceId}/projects/{projectId}/runbookSnapshots{/name}{?skip,take,searchByName}"                              // GET
	RunbookSnapshotRunPreview   = "/api/{spaceId}/runbookSnapshots/{snapshotId}/runbookRuns/preview/{environmentId}{?includeDisabledSteps}"           // GET
	RunbookRunTenantPreview     = "/api/{spaceId}/projects/{projectId}/runbooks/{runbookId}/runbookRuns/previews"                                     // POST
	Variables                   = "/api/{spaceId}/variables{/id}{?ids}"                                                                               // GET
	ProjectVariablesByGitRef    = "/api/{spaceId}/projects/{projectId}/{gitRef}/variables"
	ProjectBranchesV2           = "/api/{spaceId}/projects/{projectId}/git/branches/v2"
	ProjectBranches             = "/api/{spaceId}/projects/{projectId}/git/branches"
)

Types

type URITemplateCache

type URITemplateCache struct {
	// contains filtered or unexported fields
}

func NewUriTemplateCache

func NewUriTemplateCache() *URITemplateCache

func (*URITemplateCache) Expand

func (c *URITemplateCache) Expand(uriTemplate string, value any) (string, error)

func (*URITemplateCache) ExpandLinked

func (c *URITemplateCache) ExpandLinked(resource *resources.Resource, linkKey string, value any) (string, error)

func (*URITemplateCache) Intern

func (c *URITemplateCache) Intern(uriTemplate string) (*UriTemplate, error)

type UriTemplate

type UriTemplate struct {
	// contains filtered or unexported fields
}

A UriTemplate is a parsed representation of a URI template.

func Parse

func Parse(rawtemplate string) (template *UriTemplate, err error)

Parse parses a URI template string into a UriTemplate object.

func (*UriTemplate) Expand

func (self *UriTemplate) Expand(value interface{}) (string, error)

Expand expands a URI template with a set of values to produce a string.

func (*UriTemplate) Names

func (self *UriTemplate) Names() []string

Names returns the names of all variables within the template.

func (UriTemplate) String

func (t UriTemplate) String() string