services

package
v0.0.0-...-893f904 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2022 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_api_vdr_services_vdr_proto protoreflect.FileDescriptor
View Source 
var VDRController_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.vdr.services.VDRController",
	HandlerType: (*VDRControllerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "resolveDID",
			Handler:    _VDRController_ResolveDID_Handler,
		},
		{
			MethodName: "saveDID",
			Handler:    _VDRController_SaveDID_Handler,
		},
		{
			MethodName: "createDID",
			Handler:    _VDRController_CreateDID_Handler,
		},
		{
			MethodName: "getDID",
			Handler:    _VDRController_GetDID_Handler,
		},
		{
			MethodName: "getDIDRecords",
			Handler:    _VDRController_GetDIDRecords_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/vdr/services/vdr.proto",
}

VDRController_ServiceDesc is the grpc.ServiceDesc for VDRController service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterVDRControllerServer 

func RegisterVDRControllerServer(s grpc.ServiceRegistrar, srv VDRControllerServer)

Types

type CreateDIDRequest 

type CreateDIDRequest struct {
	Method string                `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	Did    []byte                `protobuf:"bytes,2,opt,name=did,proto3" json:"did,omitempty"` // json.RawMessage
	Opts   map[string]*anypb.Any ``                                                            /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

CreateDIDRequest is model for create did request.

func (*CreateDIDRequest) Descriptor deprecated 

func (*CreateDIDRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDIDRequest.ProtoReflect.Descriptor instead.

func (*CreateDIDRequest) GetDid 

func (x *CreateDIDRequest) GetDid() []byte

func (*CreateDIDRequest) GetMethod 

func (x *CreateDIDRequest) GetMethod() string

func (*CreateDIDRequest) GetOpts 

func (x *CreateDIDRequest) GetOpts() map[string]*anypb.Any

func (*CreateDIDRequest) ProtoMessage 

func (*CreateDIDRequest) ProtoMessage()

func (*CreateDIDRequest) ProtoReflect 

func (x *CreateDIDRequest) ProtoReflect() protoreflect.Message

func (*CreateDIDRequest) Reset 

func (x *CreateDIDRequest) Reset()

func (*CreateDIDRequest) String 

func (x *CreateDIDRequest) String() string

type DetDIDRecordsReq 

type DetDIDRecordsReq struct {
	Page     int32 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	PageSize int32 `protobuf:"varint,2,opt,name=pageSize,proto3" json:"pageSize,omitempty"`
	// contains filtered or unexported fields
}

swagger:parameters getDIDRecords

func (*DetDIDRecordsReq) Descriptor deprecated 

func (*DetDIDRecordsReq) Descriptor() ([]byte, []int)

Deprecated: Use DetDIDRecordsReq.ProtoReflect.Descriptor instead.

func (*DetDIDRecordsReq) GetPage 

func (x *DetDIDRecordsReq) GetPage() int32

func (*DetDIDRecordsReq) GetPageSize 

func (x *DetDIDRecordsReq) GetPageSize() int32

func (*DetDIDRecordsReq) ProtoMessage 

func (*DetDIDRecordsReq) ProtoMessage()

func (*DetDIDRecordsReq) ProtoReflect 

func (x *DetDIDRecordsReq) ProtoReflect() protoreflect.Message

func (*DetDIDRecordsReq) Reset 

func (x *DetDIDRecordsReq) Reset()

func (*DetDIDRecordsReq) String 

func (x *DetDIDRecordsReq) String() string

type DidRecordResult 

type DidRecordResult struct {

	// in: body
	Result       []*types2.Record `protobuf:"bytes,1,rep,name=result,proto3" json:"result,omitempty"`
	TotalRecords int64            `protobuf:"varint,2,opt,name=total_records,json=totalRecords,proto3" json:"total_records,omitempty"`
	// contains filtered or unexported fields
}

DidRecordResult model

This is used to return did records.

GetDIDRecords retrieves the did doc containing name and didID. //TODO Add pagination feature #1566. swagger:response didRecordResult

func (*DidRecordResult) Descriptor deprecated 

func (*DidRecordResult) Descriptor() ([]byte, []int)

Deprecated: Use DidRecordResult.ProtoReflect.Descriptor instead.

func (*DidRecordResult) GetResult 

func (x *DidRecordResult) GetResult() []*types2.Record

func (*DidRecordResult) GetTotalRecords 

func (x *DidRecordResult) GetTotalRecords() int64

func (*DidRecordResult) ProtoMessage 

func (*DidRecordResult) ProtoMessage()

func (*DidRecordResult) ProtoReflect 

func (x *DidRecordResult) ProtoReflect() protoreflect.Message

func (*DidRecordResult) Reset 

func (x *DidRecordResult) Reset()

func (*DidRecordResult) String 

func (x *DidRecordResult) String() string

type DocCreateIDReq 

type DocCreateIDReq struct {

	// Params for creating the did document
	//
	// in: body
	Params *CreateDIDRequest `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

docCreateDIDReq model

This is used to create the did.

swagger:parameters saveDIDReq

func (*DocCreateIDReq) Descriptor deprecated 

func (*DocCreateIDReq) Descriptor() ([]byte, []int)

Deprecated: Use DocCreateIDReq.ProtoReflect.Descriptor instead.

func (*DocCreateIDReq) GetParams 

func (x *DocCreateIDReq) GetParams() *CreateDIDRequest

func (*DocCreateIDReq) ProtoMessage 

func (*DocCreateIDReq) ProtoMessage()

func (*DocCreateIDReq) ProtoReflect 

func (x *DocCreateIDReq) ProtoReflect() protoreflect.Message

func (*DocCreateIDReq) Reset 

func (x *DocCreateIDReq) Reset()

func (*DocCreateIDReq) String 

func (x *DocCreateIDReq) String() string

type DocResolutionResponse 

type DocResolutionResponse struct {

	// in: body
	Result *types1.DocResolution `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// contains filtered or unexported fields
}

docResolutionResponse model

This is used for returning DID document resolution response.

swagger:response docResResponse

func (*DocResolutionResponse) Descriptor deprecated 

func (*DocResolutionResponse) Descriptor() ([]byte, []int)

Deprecated: Use DocResolutionResponse.ProtoReflect.Descriptor instead.

func (*DocResolutionResponse) GetResult 

func (x *DocResolutionResponse) GetResult() *types1.DocResolution

func (*DocResolutionResponse) ProtoMessage 

func (*DocResolutionResponse) ProtoMessage()

func (*DocResolutionResponse) ProtoReflect 

func (x *DocResolutionResponse) ProtoReflect() protoreflect.Message

func (*DocResolutionResponse) Reset 

func (x *DocResolutionResponse) Reset()

func (*DocResolutionResponse) String 

func (x *DocResolutionResponse) String() string

type DocumentRes 

type DocumentRes struct {

	// in: body
	Did []byte `protobuf:"bytes,1,opt,name=did,proto3" json:"did,omitempty"` // json.RawMessage
	// contains filtered or unexported fields
}

DocumentRes model

This is used for returning query connection result for single record search

swagger:response documentRes

func (*DocumentRes) Descriptor deprecated 

func (*DocumentRes) Descriptor() ([]byte, []int)

Deprecated: Use DocumentRes.ProtoReflect.Descriptor instead.

func (*DocumentRes) GetDid 

func (x *DocumentRes) GetDid() []byte

func (*DocumentRes) ProtoMessage 

func (*DocumentRes) ProtoMessage()

func (*DocumentRes) ProtoReflect 

func (x *DocumentRes) ProtoReflect() protoreflect.Message

func (*DocumentRes) Reset 

func (x *DocumentRes) Reset()

func (*DocumentRes) String 

func (x *DocumentRes) String() string

type GetDIDReq 

type GetDIDReq struct {

	// DID ID - pass the did
	//
	// in: path
	// required: true
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

GetDIDReq model

This is used to retrieve the did document.

swagger:parameters getDIDReq

func (*GetDIDReq) Descriptor deprecated 

func (*GetDIDReq) Descriptor() ([]byte, []int)

Deprecated: Use GetDIDReq.ProtoReflect.Descriptor instead.

func (*GetDIDReq) GetId 

func (x *GetDIDReq) GetId() string

func (*GetDIDReq) ProtoMessage 

func (*GetDIDReq) ProtoMessage()

func (*GetDIDReq) ProtoReflect 

func (x *GetDIDReq) ProtoReflect() protoreflect.Message

func (*GetDIDReq) Reset 

func (x *GetDIDReq) Reset()

func (*GetDIDReq) String 

func (x *GetDIDReq) String() string

type ResolveDIDReq 

type ResolveDIDReq struct {

	// DID ID - pass the did
	//
	// in: path
	// required: true
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

ResolveDIDReq model

This is used to retrieve the did document.

swagger:parameters resolveDIDReq

func (*ResolveDIDReq) Descriptor deprecated 

func (*ResolveDIDReq) Descriptor() ([]byte, []int)

Deprecated: Use ResolveDIDReq.ProtoReflect.Descriptor instead.

func (*ResolveDIDReq) GetId 

func (x *ResolveDIDReq) GetId() string

func (*ResolveDIDReq) ProtoMessage 

func (*ResolveDIDReq) ProtoMessage()

func (*ResolveDIDReq) ProtoReflect 

func (x *ResolveDIDReq) ProtoReflect() protoreflect.Message

func (*ResolveDIDReq) Reset 

func (x *ResolveDIDReq) Reset()

func (*ResolveDIDReq) String 

func (x *ResolveDIDReq) String() string

type ResolveDIDRes 

type ResolveDIDRes struct {

	// in: body
	Result []byte `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"` // json.RawMessage
	// contains filtered or unexported fields
}

ResolveDIDRes model

This is used for returning DID resolution response.

swagger:response resolveDIDRes

func (*ResolveDIDRes) Descriptor deprecated 

func (*ResolveDIDRes) Descriptor() ([]byte, []int)

Deprecated: Use ResolveDIDRes.ProtoReflect.Descriptor instead.

func (*ResolveDIDRes) GetResult 

func (x *ResolveDIDRes) GetResult() []byte

func (*ResolveDIDRes) ProtoMessage 

func (*ResolveDIDRes) ProtoMessage()

func (*ResolveDIDRes) ProtoReflect 

func (x *ResolveDIDRes) ProtoReflect() protoreflect.Message

func (*ResolveDIDRes) Reset 

func (x *ResolveDIDRes) Reset()

func (*ResolveDIDRes) String 

func (x *ResolveDIDRes) String() string

type SaveDIDReq 

type SaveDIDReq struct {

	// Params for saving the did document (pass the did document as json raw message)
	//
	// in: body
	Params *types.DIDArgs `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

SaveDIDReq model

This is used to save the did with did document.

swagger:parameters saveDIDReq

func (*SaveDIDReq) Descriptor deprecated 

func (*SaveDIDReq) Descriptor() ([]byte, []int)

Deprecated: Use SaveDIDReq.ProtoReflect.Descriptor instead.

func (*SaveDIDReq) GetParams 

func (x *SaveDIDReq) GetParams() *types.DIDArgs

func (*SaveDIDReq) ProtoMessage 

func (*SaveDIDReq) ProtoMessage()

func (*SaveDIDReq) ProtoReflect 

func (x *SaveDIDReq) ProtoReflect() protoreflect.Message

func (*SaveDIDReq) Reset 

func (x *SaveDIDReq) Reset()

func (*SaveDIDReq) String 

func (x *SaveDIDReq) String() string

type UnimplementedVDRControllerServer 

type UnimplementedVDRControllerServer struct {
}

UnimplementedVDRControllerServer must be embedded to have forward compatible implementations.

func (UnimplementedVDRControllerServer) CreateDID 

func (UnimplementedVDRControllerServer) CreateDID(context.Context, *CreateDIDRequest) (*DocumentRes, error)

func (UnimplementedVDRControllerServer) GetDID 

func (UnimplementedVDRControllerServer) GetDID(context.Context, *GetDIDReq) (*DocumentRes, error)

func (UnimplementedVDRControllerServer) GetDIDRecords 

func (UnimplementedVDRControllerServer) GetDIDRecords(context.Context, *DetDIDRecordsReq) (*DidRecordResult, error)

func (UnimplementedVDRControllerServer) ResolveDID 

func (UnimplementedVDRControllerServer) ResolveDID(context.Context, *ResolveDIDReq) (*ResolveDIDRes, error)

func (UnimplementedVDRControllerServer) SaveDID 

func (UnimplementedVDRControllerServer) SaveDID(context.Context, *SaveDIDReq) (*types.EmptyResponse, error)

type UnsafeVDRControllerServer 

type UnsafeVDRControllerServer interface {
	// contains filtered or unexported methods
}

UnsafeVDRControllerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VDRControllerServer will result in compilation errors.

type VDRControllerClient 

type VDRControllerClient interface {
	// ResolveDID resolve did.
	// ResolveDID swagger:route GET /vdr/did/resolve/{id} vdr resolveDIDReq
	//
	// Resolve did
	//
	// Responses:
	//    default: genericError
	//        200: resolveDIDRes
	ResolveDID(ctx context.Context, in *ResolveDIDReq, opts ...grpc.CallOption) (*ResolveDIDRes, error)
	// SaveDID saves the did doc to the store.
	// SaveDID swagger:route POST /vdr/did vdr saveDIDReq
	//
	// Saves a did document with the friendly name.
	//
	// Responses:
	//    default: genericError
	SaveDID(ctx context.Context, in *SaveDIDReq, opts ...grpc.CallOption) (*types.EmptyResponse, error)
	// CreateDID create the did doc.
	// CreateDID swagger:route POST /vdr/did/create vdr createDIDReq
	//
	// Create a did document.
	//
	// Responses:
	//    default: genericError
	//        200: documentRes
	CreateDID(ctx context.Context, in *CreateDIDRequest, opts ...grpc.CallOption) (*DocumentRes, error)
	// GetDID retrieves the did from the store.
	// GetDID swagger:route GET /vdr/did/{id} vdr getDIDReq
	//
	// Gets did document with the friendly name.
	//
	// Responses:
	//    default: genericError
	//        200: documentRes
	GetDID(ctx context.Context, in *GetDIDReq, opts ...grpc.CallOption) (*DocumentRes, error)
	// GetDIDRecords retrieves the did doc containing name and didID.
	// GetDIDRecords swagger:route GET /vdr/did/records vdr getDIDRecords
	//
	// Retrieves the did records
	//
	// Responses:
	//    default: genericError
	//        200: didRecordResult
	GetDIDRecords(ctx context.Context, in *DetDIDRecordsReq, opts ...grpc.CallOption) (*DidRecordResult, error)
}

VDRControllerClient is the client API for VDRController service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewVDRControllerClient 

func NewVDRControllerClient(cc grpc.ClientConnInterface) VDRControllerClient

type VDRControllerServer 

type VDRControllerServer interface {
	// ResolveDID resolve did.
	// ResolveDID swagger:route GET /vdr/did/resolve/{id} vdr resolveDIDReq
	//
	// Resolve did
	//
	// Responses:
	//    default: genericError
	//        200: resolveDIDRes
	ResolveDID(context.Context, *ResolveDIDReq) (*ResolveDIDRes, error)
	// SaveDID saves the did doc to the store.
	// SaveDID swagger:route POST /vdr/did vdr saveDIDReq
	//
	// Saves a did document with the friendly name.
	//
	// Responses:
	//    default: genericError
	SaveDID(context.Context, *SaveDIDReq) (*types.EmptyResponse, error)
	// CreateDID create the did doc.
	// CreateDID swagger:route POST /vdr/did/create vdr createDIDReq
	//
	// Create a did document.
	//
	// Responses:
	//    default: genericError
	//        200: documentRes
	CreateDID(context.Context, *CreateDIDRequest) (*DocumentRes, error)
	// GetDID retrieves the did from the store.
	// GetDID swagger:route GET /vdr/did/{id} vdr getDIDReq
	//
	// Gets did document with the friendly name.
	//
	// Responses:
	//    default: genericError
	//        200: documentRes
	GetDID(context.Context, *GetDIDReq) (*DocumentRes, error)
	// GetDIDRecords retrieves the did doc containing name and didID.
	// GetDIDRecords swagger:route GET /vdr/did/records vdr getDIDRecords
	//
	// Retrieves the did records
	//
	// Responses:
	//    default: genericError
	//        200: didRecordResult
	GetDIDRecords(context.Context, *DetDIDRecordsReq) (*DidRecordResult, error)
	// contains filtered or unexported methods
}

VDRControllerServer is the server API for VDRController service. All implementations must embed UnimplementedVDRControllerServer for forward compatibility

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.