Back to

Package jsonreference

Latest Go to latest

The latest major version is .

Published: Jul 16, 2020 | License: Apache-2.0 | Module:


type Ref

type Ref struct {
	HasFullURL      bool
	HasURLPathOnly  bool
	HasFragmentOnly bool
	HasFileScheme   bool
	HasFullFilePath bool
	// contains filtered or unexported fields

Ref represents a json reference object

func MustCreateRef

func MustCreateRef(ref string) Ref

MustCreateRef parses the ref string and panics when it's invalid. Use the New method for a version that returns an error

func New

func New(jsonReferenceString string) (Ref, error)

New creates a new reference for the given string

func (*Ref) GetPointer

func (r *Ref) GetPointer() *jsonpointer.Pointer

GetPointer gets the json pointer for this reference

func (*Ref) GetURL

func (r *Ref) GetURL() *url.URL

GetURL gets the URL for this reference

func (*Ref) Inherits

func (r *Ref) Inherits(child Ref) (*Ref, error)

Inherits creates a new reference from a parent and a child If the child cannot inherit from the parent, an error is returned

func (*Ref) IsCanonical

func (r *Ref) IsCanonical() bool

IsCanonical returns true when this pointer starts with http(s):// or file://

func (*Ref) IsRoot

func (r *Ref) IsRoot() bool

IsRoot returns true if this reference is a root document

func (*Ref) String

func (r *Ref) String() string

String returns the best version of the url for this reference

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier