v1

Documentation

Overview

Package v1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Package v1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Index

• Constants
• Variables
• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type CreateDirectoryJSONRequestBody
• type CreateDirectoryRequest
• type CreateRootDirectoryJSONRequestBody
• type Directory
  • func (d *Directory) IsDeleted() bool
  • func (d *Directory) IsRoot() bool
• type DirectoryEvent
• type DirectoryFetch
  • func (gd *DirectoryFetch) Parse(r io.Reader) error
• type DirectoryID
  • func ParseDirectoryID(id string) (DirectoryID, error)
  • func (did DirectoryID) MarshalJSON() ([]byte, error)
  • func (did *DirectoryID) Scan(value interface{}) error
  • func (did DirectoryID) String() string
  • func (did *DirectoryID) UnmarshalJSON(b []byte) error
  • func (did DirectoryID) Value() (driver.Value, error)
• type DirectoryList
  • func (ld *DirectoryList) Parse(r io.Reader) error
• type DirectoryMetadata
  • func (dm *DirectoryMetadata) Scan(value interface{}) error
  • func (dm DirectoryMetadata) Value() (driver.Value, error)
• type DirectoryRequestMeta
• type Error
• type EventType
• type GetDirectoryParams
• type ListChildrenParams
• type ListParentsParams
• type ListParentsUntilParams
• type ListRootsParams
• type NewDirectory
• type UpdateDirectoryJSONRequestBody
• type UpdateDirectoryRequest
• type WithDeleted

Constants

const APIVersion = "v1"

const (
	// EventSubject is the subject that events are published to.
	EventSubject = "directories"
)

Variables

var ErrParsingID = errors.New("error parsing id")

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type CreateDirectoryJSONRequestBody

type CreateDirectoryJSONRequestBody = CreateDirectoryRequest

CreateDirectoryJSONRequestBody defines body for CreateDirectory for application/json ContentType.

type CreateDirectoryRequest

type CreateDirectoryRequest struct {
	Metadata *DirectoryMetadata `json:"metadata,omitempty"`
	Name     string             `binding:"required" json:"name"`
	Version  string             `json:"version"`
}

CreateDirectoryRequest defines model for CreateDirectoryRequest.

type CreateRootDirectoryJSONRequestBody

type CreateRootDirectoryJSONRequestBody = CreateDirectoryRequest

CreateRootDirectoryJSONRequestBody defines body for CreateRootDirectory for application/json ContentType.

type Directory

type Directory struct {
	CreatedAt time.Time          `json:"createdAt"`
	DeletedAt *time.Time         `json:"deletedAt,omitempty"`
	Id        DirectoryID        `json:"id"`
	Metadata  *DirectoryMetadata `json:"metadata,omitempty"`
	Name      string             `binding:"required" json:"name"`
	Parent    *DirectoryID       `json:"parent,omitempty"`
	UpdatedAt time.Time          `json:"updatedAt"`
}

Directory defines model for Directory.

func (*Directory) IsDeleted

func (d *Directory) IsDeleted() bool

func (*Directory) IsRoot

func (d *Directory) IsRoot() bool

type DirectoryEvent

type DirectoryEvent struct {
	DirectoryRequestMeta
	Type      EventType `json:"type"`
	Time      time.Time `json:"time"`
	Directory Directory `json:"directory"`
}

DirectoryEvent is the event that is sent to the event stream.

type DirectoryFetch

type DirectoryFetch struct {
	Directory Directory `json:"directory"`
	Version   string    `json:"version"`
}

DirectoryFetch defines model for DirectoryFetch.

func (*DirectoryFetch) Parse

func (gd *DirectoryFetch) Parse(r io.Reader) error

type DirectoryID

type DirectoryID uuid.UUID

func ParseDirectoryID

func ParseDirectoryID(id string) (DirectoryID, error)

func (DirectoryID) MarshalJSON

func (did DirectoryID) MarshalJSON() ([]byte, error)

func (*DirectoryID) Scan

func (did *DirectoryID) Scan(value interface{}) error

func (DirectoryID) String

func (did DirectoryID) String() string

func (*DirectoryID) UnmarshalJSON

func (did *DirectoryID) UnmarshalJSON(b []byte) error

func (DirectoryID) Value

func (did DirectoryID) Value() (driver.Value, error)

type DirectoryList

type DirectoryList struct {
	Directories []DirectoryID `json:"directories"`
	Version     string        `json:"version"`
}

DirectoryList defines model for DirectoryList.

func (*DirectoryList) Parse

func (ld *DirectoryList) Parse(r io.Reader) error

type DirectoryMetadata

type DirectoryMetadata map[string]string

func (*DirectoryMetadata) Scan

func (dm *DirectoryMetadata) Scan(value interface{}) error

func (DirectoryMetadata) Value

func (dm DirectoryMetadata) Value() (driver.Value, error)

type DirectoryRequestMeta

type DirectoryRequestMeta struct {
	Version string `json:"version"`
}

DirectoryRequestMeta defines model for DirectoryRequestMeta.

type Error

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

Error defines model for Error.

type EventType

type EventType string

EventType is the type of event that occurred.

const (
	EventTypeCreate     EventType = "create"
	EventTypeUpdate     EventType = "update"
	EventTypeDelete     EventType = "delete"
	EventTypeDeleteHard EventType = "deletehard"
)

type GetDirectoryParams

type GetDirectoryParams struct {
	WithDeleted *WithDeleted `form:"with_deleted,omitempty" json:"with_deleted,omitempty"`
}

GetDirectoryParams defines parameters for GetDirectory.

type ListChildrenParams

type ListChildrenParams struct {
	WithDeleted *WithDeleted `form:"with_deleted,omitempty" json:"with_deleted,omitempty"`
}

ListChildrenParams defines parameters for ListChildren.

type ListParentsParams

type ListParentsParams struct {
	WithDeleted *WithDeleted `form:"with_deleted,omitempty" json:"with_deleted,omitempty"`
}

ListParentsParams defines parameters for ListParents.

type ListParentsUntilParams

type ListParentsUntilParams struct {
	WithDeleted *WithDeleted `form:"with_deleted,omitempty" json:"with_deleted,omitempty"`
}

ListParentsUntilParams defines parameters for ListParentsUntil.

type ListRootsParams

type ListRootsParams struct {
	WithDeleted *WithDeleted `form:"with_deleted,omitempty" json:"with_deleted,omitempty"`
}

ListRootsParams defines parameters for ListRoots.

type NewDirectory

type NewDirectory struct {
	Metadata *DirectoryMetadata `json:"metadata,omitempty"`
	Name     string             `binding:"required" json:"name"`
}

NewDirectory defines model for NewDirectory.

type UpdateDirectoryJSONRequestBody

type UpdateDirectoryJSONRequestBody = UpdateDirectoryRequest

UpdateDirectoryJSONRequestBody defines body for UpdateDirectory for application/json ContentType.

type UpdateDirectoryRequest

type UpdateDirectoryRequest struct {
	Metadata *DirectoryMetadata `json:"metadata,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Version  string             `json:"version"`
}

UpdateDirectoryRequest defines model for UpdateDirectoryRequest.

type WithDeleted

type WithDeleted = bool

WithDeleted defines model for with_deleted.