definitions

Documentation

Overview

Package definitions provides service definitions for oto generated service.

These service are wrappers for the packages in ikuzo/service. By using the templates in the templates package we aim to create greater consistency in the user facing APIs.

Index

• type DeleteNamespaceRequest
• type DeleteNamespaceResponse
• type GetNamespaceRequest
• type GetNamespaceResponse
• type NamespaceService
• type PutNamespaceRequest
• type PutNamespaceResponse
• type SearchNamespaceRequest
• type SearchNamespaceResponse

Types

type DeleteNamespaceRequest

type DeleteNamespaceRequest struct {
	// ID is the unique identifier of a Namespace
	ID string
}

DeleteNamespaceRequest is the input object for NamespaceService.DeleteNamespace

type DeleteNamespaceResponse

type DeleteNamespaceResponse struct{}

DeleteNamespaceRequest is the output object for NamespaceService.DeleteNamespace

type GetNamespaceRequest

type GetNamespaceRequest struct {

	// ID is the unique identifier of the namespace
	// example: "123"
	ID string
}

GetNamespaceRequest is the input object for GetNamespaceService.GetNamespace

type GetNamespaceResponse

type GetNamespaceResponse struct {

	// Namespace is the Namespace
	Namespace *domain.Namespace
}

GetNamespaceResponse is the output object for GetNamespaceService.GetNamespace

type NamespaceService

type NamespaceService interface {

	// DeletetNamespace deletes a Namespace
	// CAUTION: "You may lose data"
	DeleteNamespace(DeleteNamespaceRequest) DeleteNamespaceResponse

	// GetNamespace gets a Namespace
	GetNamespace(GetNamespaceRequest) GetNamespaceResponse

	// PutNamespace stores a Namespace
	PutNamespace(PutNamespaceRequest) PutNamespaceResponse

	// Search returns a filtered list of Namespaces
	Search(SearchNamespaceRequest) SearchNamespaceResponse
}

NamespaceService allows you to programmatically manage namespaces

type PutNamespaceRequest

type PutNamespaceRequest struct {
	Namespace *domain.Namespace
}

PutNamespaceRequest is the input object for NamespaceService.PutNamespace

type PutNamespaceResponse

type PutNamespaceResponse struct{}

PutNamespaceResponse is the output object for NamespaceService.PutNamespace

type SearchNamespaceRequest

type SearchNamespaceRequest struct {
	// Prefix for a Namespace
	Prefix string

	// BaseURI for a Namespace
	BaseURI string
}

SearchNamespaceRequest is the input object for NamespaceService.Search

type SearchNamespaceResponse

type SearchNamespaceResponse struct {
	// Hits returns the list of matching Namespaces
	Hits []*domain.Namespace

	// More indicates that there may be more search results. If true, make the same Search request passing this Cursor.
	More bool
}

SearchNamespaceResponse is the output object for NamespaceService.Search