models

package

v1.15.0 Latest Latest Go to latest Published: Dec 31, 2025 License: MIT Imports: 1 Imported by: 9

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ONSdigital/dp-hierarchy-api

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Element
- func (e *Element) AddLinks(host, instanceID, dimensionName, codelistID string, withID bool)
- func (e *Element) AddRewrittenLinks(host, codeListURL, instanceID, dimensionName, codelistID string, withID bool)
type Link
- func GetLink(baseURL, linkID string) *Link
- func GetLinkWithID(baseURL, linkID, id string) *Link
type Response
- func (r *Response) AddLinks(host, instanceID, dimensionName, codelistID string, isRoot bool)
- func (r *Response) AddLinksWithRewriting(host, codeListURL, instanceID, dimensionName, codelistID string, isRoot bool)

Constants ¶

This section is empty.

Variables ¶

View Source

var CodelistURL string

CodelistURL set by main() to make accessible to all models users

Functions ¶

This section is empty.

Types ¶

type Element ¶

type Element struct {
	ID           string          `json:"-"`
	Label        string          `json:"label"`
	NoOfChildren int64           `json:"no_of_children,omitempty"`
	Order        *int64          `json:"order,omitempty"`
	Links        map[string]Link `json:"links,omitempty"`
	HasData      bool            `json:"has_data"`
}

Element is a item in a list within a Response

func (*Element) AddLinks ¶

func (e *Element) AddLinks(host, instanceID, dimensionName, codelistID string, withID bool)

AddLinks adds self and codelist links for Elements

func (*Element) AddRewrittenLinks ¶ added in v1.13.0

func (e *Element) AddRewrittenLinks(host, codeListURL, instanceID, dimensionName, codelistID string, withID bool)

AddRewrittenLinks adds self and codelist links for Elements when enableURLRewriting is true

type Link ¶

type Link struct {
	ID   string `json:"id,omitempty"`
	HRef string `json:"href,omitempty"`
}

Link is a combination of ID and HRef for the object in question

func GetLink ¶

func GetLink(baseURL, linkID string) *Link

GetLink returns a Link{id,href} object for the given url/id (or just url if id is empty)

func GetLinkWithID ¶

func GetLinkWithID(baseURL, linkID, id string) *Link

GetLinkWithID returns a Link{id,href} object for the given url/id (or just url if id is empty)

type Response ¶

type Response struct {
	ID           string          `json:"-"`
	Label        string          `json:"label"`
	Children     []*Element      `json:"children,omitempty"`
	NoOfChildren int64           `json:"no_of_children,omitempty"`
	Order        *int64          `json:"order,omitempty"`
	Links        map[string]Link `json:"links,omitempty"`
	HasData      bool            `json:"has_data"`
	Breadcrumbs  []*Element      `json:"breadcrumbs,omitempty"`
}

Response models a node in the hierarchy

func (*Response) AddLinks ¶

func (r *Response) AddLinks(host, instanceID, dimensionName, codelistID string, isRoot bool)

AddLinks adds links (self, codelist and populates children links)

func (*Response) AddLinksWithRewriting ¶ added in v1.13.0

func (r *Response) AddLinksWithRewriting(host, codeListURL, instanceID, dimensionName, codelistID string, isRoot bool)

AddLinksWithRewriting adds links (self, codelist and populates children links) when enableURLRewriting is true

Source Files ¶

View all Source files

response.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL