public

package
v0.0.0-...-a0d1ad3 Latest Latest
Warning

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

Go to latest
Published: Nov 25, 2022 License: MIT Imports: 17 Imported by: 0

Documentation

Overview

Package public is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_proto_v1alpha1_public_public_proto protoreflect.FileDescriptor
View Source
var Public_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "hvx.api.v1alpha1.public.proto.Public",
	HandlerType: (*PublicServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInstance",
			Handler:    _Public_GetInstance_Handler,
		},
		{
			MethodName: "CreateAccounts",
			Handler:    _Public_CreateAccounts_Handler,
		},
		{
			MethodName: "GetWebfinger",
			Handler:    _Public_GetWebfinger_Handler,
		},
		{
			MethodName: "GetActor",
			Handler:    _Public_GetActor_Handler,
		},
		{
			MethodName: "GetChannel",
			Handler:    _Public_GetChannel_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/v1alpha1/public/public.proto",
}

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

Functions

func RegisterPublicHandler

func RegisterPublicHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterPublicHandler registers the http handlers for service Public to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterPublicHandlerClient

func RegisterPublicHandlerClient(ctx context.Context, mux *runtime.ServeMux, client PublicClient) error

RegisterPublicHandlerClient registers the http handlers for service Public to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "PublicClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "PublicClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "PublicClient" to call the correct interceptors.

func RegisterPublicHandlerFromEndpoint

func RegisterPublicHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterPublicHandlerFromEndpoint is same as RegisterPublicHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterPublicHandlerServer

func RegisterPublicHandlerServer(ctx context.Context, mux *runtime.ServeMux, server PublicServer) error

RegisterPublicHandlerServer registers the http handlers for service Public to "mux". UnaryRPC :call PublicServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterPublicHandlerFromEndpoint instead.

func RegisterPublicServer

func RegisterPublicServer(s grpc.ServiceRegistrar, srv PublicServer)

Types

type CreateAccountsRequest

type CreateAccountsRequest struct {
	Username  string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password  string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	Mail      string `protobuf:"bytes,3,opt,name=mail,proto3" json:"mail,omitempty"`
	PublicKey string `protobuf:"bytes,4,opt,name=publicKey,proto3" json:"publicKey,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateAccountsRequest) Descriptor deprecated

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

Deprecated: Use CreateAccountsRequest.ProtoReflect.Descriptor instead.

func (*CreateAccountsRequest) GetMail

func (x *CreateAccountsRequest) GetMail() string

func (*CreateAccountsRequest) GetPassword

func (x *CreateAccountsRequest) GetPassword() string

func (*CreateAccountsRequest) GetPublicKey

func (x *CreateAccountsRequest) GetPublicKey() string

func (*CreateAccountsRequest) GetUsername

func (x *CreateAccountsRequest) GetUsername() string

func (*CreateAccountsRequest) ProtoMessage

func (*CreateAccountsRequest) ProtoMessage()

func (*CreateAccountsRequest) ProtoReflect

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

func (*CreateAccountsRequest) Reset

func (x *CreateAccountsRequest) Reset()

func (*CreateAccountsRequest) String

func (x *CreateAccountsRequest) String() string

type CreateAccountsResponse

type CreateAccountsResponse struct {
	Code     string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Response string `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateAccountsResponse) Descriptor deprecated

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

Deprecated: Use CreateAccountsResponse.ProtoReflect.Descriptor instead.

func (*CreateAccountsResponse) GetCode

func (x *CreateAccountsResponse) GetCode() string

func (*CreateAccountsResponse) GetResponse

func (x *CreateAccountsResponse) GetResponse() string

func (*CreateAccountsResponse) ProtoMessage

func (*CreateAccountsResponse) ProtoMessage()

func (*CreateAccountsResponse) ProtoReflect

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

func (*CreateAccountsResponse) Reset

func (x *CreateAccountsResponse) Reset()

func (*CreateAccountsResponse) String

func (x *CreateAccountsResponse) String() string

type GetActorRequest

type GetActorRequest struct {
	Actor string `protobuf:"bytes,1,opt,name=actor,proto3" json:"actor,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActorRequest) Descriptor deprecated

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

Deprecated: Use GetActorRequest.ProtoReflect.Descriptor instead.

func (*GetActorRequest) GetActor

func (x *GetActorRequest) GetActor() string

func (*GetActorRequest) ProtoMessage

func (*GetActorRequest) ProtoMessage()

func (*GetActorRequest) ProtoReflect

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

func (*GetActorRequest) Reset

func (x *GetActorRequest) Reset()

func (*GetActorRequest) String

func (x *GetActorRequest) String() string

type GetActorResponse

type GetActorResponse struct {
	Context           []string                    `protobuf:"bytes,1,rep,name=context,json=@context,proto3" json:"context,omitempty"`
	Id                string                      `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Type              string                      `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	Following         string                      `protobuf:"bytes,4,opt,name=following,proto3" json:"following,omitempty"`
	Followers         string                      `protobuf:"bytes,5,opt,name=followers,proto3" json:"followers,omitempty"`
	Inbox             string                      `protobuf:"bytes,6,opt,name=inbox,proto3" json:"inbox,omitempty"`
	Outbox            string                      `protobuf:"bytes,7,opt,name=outbox,proto3" json:"outbox,omitempty"`
	PreferredUsername string                      `protobuf:"bytes,8,opt,name=preferredUsername,proto3" json:"preferredUsername,omitempty"`
	Name              string                      `protobuf:"bytes,9,opt,name=name,proto3" json:"name,omitempty"`
	Summary           string                      `protobuf:"bytes,10,opt,name=summary,proto3" json:"summary,omitempty"`
	Url               string                      `protobuf:"bytes,11,opt,name=url,proto3" json:"url,omitempty"`
	PublicKey         *GetActorResponse_PublicKey `protobuf:"bytes,12,opt,name=publicKey,proto3" json:"publicKey,omitempty"`
	Icon              *GetActorResponse_Icon      `protobuf:"bytes,13,opt,name=icon,proto3" json:"icon,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActorResponse) Descriptor deprecated

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

Deprecated: Use GetActorResponse.ProtoReflect.Descriptor instead.

func (*GetActorResponse) GetContext

func (x *GetActorResponse) GetContext() []string

func (*GetActorResponse) GetFollowers

func (x *GetActorResponse) GetFollowers() string

func (*GetActorResponse) GetFollowing

func (x *GetActorResponse) GetFollowing() string

func (*GetActorResponse) GetIcon

func (*GetActorResponse) GetId

func (x *GetActorResponse) GetId() string

func (*GetActorResponse) GetInbox

func (x *GetActorResponse) GetInbox() string

func (*GetActorResponse) GetName

func (x *GetActorResponse) GetName() string

func (*GetActorResponse) GetOutbox

func (x *GetActorResponse) GetOutbox() string

func (*GetActorResponse) GetPreferredUsername

func (x *GetActorResponse) GetPreferredUsername() string

func (*GetActorResponse) GetPublicKey

func (x *GetActorResponse) GetPublicKey() *GetActorResponse_PublicKey

func (*GetActorResponse) GetSummary

func (x *GetActorResponse) GetSummary() string

func (*GetActorResponse) GetType

func (x *GetActorResponse) GetType() string

func (*GetActorResponse) GetUrl

func (x *GetActorResponse) GetUrl() string

func (*GetActorResponse) ProtoMessage

func (*GetActorResponse) ProtoMessage()

func (*GetActorResponse) ProtoReflect

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

func (*GetActorResponse) Reset

func (x *GetActorResponse) Reset()

func (*GetActorResponse) String

func (x *GetActorResponse) String() string

type GetActorResponse_Icon

type GetActorResponse_Icon struct {
	Type      string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Url       string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	MediaType string `protobuf:"bytes,3,opt,name=mediaType,proto3" json:"mediaType,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActorResponse_Icon) Descriptor deprecated

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

Deprecated: Use GetActorResponse_Icon.ProtoReflect.Descriptor instead.

func (*GetActorResponse_Icon) GetMediaType

func (x *GetActorResponse_Icon) GetMediaType() string

func (*GetActorResponse_Icon) GetType

func (x *GetActorResponse_Icon) GetType() string

func (*GetActorResponse_Icon) GetUrl

func (x *GetActorResponse_Icon) GetUrl() string

func (*GetActorResponse_Icon) ProtoMessage

func (*GetActorResponse_Icon) ProtoMessage()

func (*GetActorResponse_Icon) ProtoReflect

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

func (*GetActorResponse_Icon) Reset

func (x *GetActorResponse_Icon) Reset()

func (*GetActorResponse_Icon) String

func (x *GetActorResponse_Icon) String() string

type GetActorResponse_PublicKey

type GetActorResponse_PublicKey struct {
	Id           string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Owner        string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"`
	PublicKeyPem string `protobuf:"bytes,3,opt,name=publicKeyPem,proto3" json:"publicKeyPem,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActorResponse_PublicKey) Descriptor deprecated

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

Deprecated: Use GetActorResponse_PublicKey.ProtoReflect.Descriptor instead.

func (*GetActorResponse_PublicKey) GetId

func (*GetActorResponse_PublicKey) GetOwner

func (x *GetActorResponse_PublicKey) GetOwner() string

func (*GetActorResponse_PublicKey) GetPublicKeyPem

func (x *GetActorResponse_PublicKey) GetPublicKeyPem() string

func (*GetActorResponse_PublicKey) ProtoMessage

func (*GetActorResponse_PublicKey) ProtoMessage()

func (*GetActorResponse_PublicKey) ProtoReflect

func (*GetActorResponse_PublicKey) Reset

func (x *GetActorResponse_PublicKey) Reset()

func (*GetActorResponse_PublicKey) String

func (x *GetActorResponse_PublicKey) String() string

type GetChannelRequest

type GetChannelRequest struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*GetChannelRequest) Descriptor deprecated

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

Deprecated: Use GetChannelRequest.ProtoReflect.Descriptor instead.

func (*GetChannelRequest) GetChannel

func (x *GetChannelRequest) GetChannel() string

func (*GetChannelRequest) ProtoMessage

func (*GetChannelRequest) ProtoMessage()

func (*GetChannelRequest) ProtoReflect

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

func (*GetChannelRequest) Reset

func (x *GetChannelRequest) Reset()

func (*GetChannelRequest) String

func (x *GetChannelRequest) String() string

type GetInstanceResponse

type GetInstanceResponse struct {
	Code        string `protobuf:"bytes,1,opt,name=Code,proto3" json:"Code,omitempty"`
	Version     string `protobuf:"bytes,2,opt,name=Version,proto3" json:"Version,omitempty"`
	Build       string `protobuf:"bytes,3,opt,name=Build,proto3" json:"Build,omitempty"`
	Maintainer  string `protobuf:"bytes,4,opt,name=Maintainer,proto3" json:"Maintainer,omitempty"`
	Repo        string `protobuf:"bytes,5,opt,name=Repo,proto3" json:"Repo,omitempty"`
	Host        string `protobuf:"bytes,6,opt,name=Host,proto3" json:"Host,omitempty"`
	MatrixAPI   string `protobuf:"bytes,7,opt,name=MatrixAPI,proto3" json:"MatrixAPI,omitempty"`
	IpfsAPI     string `protobuf:"bytes,8,opt,name=IpfsAPI,proto3" json:"IpfsAPI,omitempty"`
	IpfsGateway string `protobuf:"bytes,9,opt,name=IpfsGateway,proto3" json:"IpfsGateway,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInstanceResponse) Descriptor deprecated

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

Deprecated: Use GetInstanceResponse.ProtoReflect.Descriptor instead.

func (*GetInstanceResponse) GetBuild

func (x *GetInstanceResponse) GetBuild() string

func (*GetInstanceResponse) GetCode

func (x *GetInstanceResponse) GetCode() string

func (*GetInstanceResponse) GetHost

func (x *GetInstanceResponse) GetHost() string

func (*GetInstanceResponse) GetIpfsAPI

func (x *GetInstanceResponse) GetIpfsAPI() string

func (*GetInstanceResponse) GetIpfsGateway

func (x *GetInstanceResponse) GetIpfsGateway() string

func (*GetInstanceResponse) GetMaintainer

func (x *GetInstanceResponse) GetMaintainer() string

func (*GetInstanceResponse) GetMatrixAPI

func (x *GetInstanceResponse) GetMatrixAPI() string

func (*GetInstanceResponse) GetRepo

func (x *GetInstanceResponse) GetRepo() string

func (*GetInstanceResponse) GetVersion

func (x *GetInstanceResponse) GetVersion() string

func (*GetInstanceResponse) ProtoMessage

func (*GetInstanceResponse) ProtoMessage()

func (*GetInstanceResponse) ProtoReflect

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

func (*GetInstanceResponse) Reset

func (x *GetInstanceResponse) Reset()

func (*GetInstanceResponse) String

func (x *GetInstanceResponse) String() string

type GetInstancesResponse

type GetInstancesResponse struct {
	Instances []*GetInstanceResponse `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInstancesResponse) Descriptor deprecated

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

Deprecated: Use GetInstancesResponse.ProtoReflect.Descriptor instead.

func (*GetInstancesResponse) GetInstances

func (x *GetInstancesResponse) GetInstances() []*GetInstanceResponse

func (*GetInstancesResponse) ProtoMessage

func (*GetInstancesResponse) ProtoMessage()

func (*GetInstancesResponse) ProtoReflect

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

func (*GetInstancesResponse) Reset

func (x *GetInstancesResponse) Reset()

func (*GetInstancesResponse) String

func (x *GetInstancesResponse) String() string

type GetWebfingerRequest

type GetWebfingerRequest struct {
	Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWebfingerRequest) Descriptor deprecated

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

Deprecated: Use GetWebfingerRequest.ProtoReflect.Descriptor instead.

func (*GetWebfingerRequest) GetResource

func (x *GetWebfingerRequest) GetResource() string

func (*GetWebfingerRequest) ProtoMessage

func (*GetWebfingerRequest) ProtoMessage()

func (*GetWebfingerRequest) ProtoReflect

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

func (*GetWebfingerRequest) Reset

func (x *GetWebfingerRequest) Reset()

func (*GetWebfingerRequest) String

func (x *GetWebfingerRequest) String() string

type GetWebfingerResponse

type GetWebfingerResponse struct {
	Subject string                      `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
	Aliases []string                    `protobuf:"bytes,2,rep,name=aliases,proto3" json:"aliases,omitempty"`
	Links   []*GetWebfingerResponseLink `protobuf:"bytes,3,rep,name=links,proto3" json:"links,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWebfingerResponse) Descriptor deprecated

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

Deprecated: Use GetWebfingerResponse.ProtoReflect.Descriptor instead.

func (*GetWebfingerResponse) GetAliases

func (x *GetWebfingerResponse) GetAliases() []string

func (*GetWebfingerResponse) GetSubject

func (x *GetWebfingerResponse) GetSubject() string

func (*GetWebfingerResponse) ProtoMessage

func (*GetWebfingerResponse) ProtoMessage()

func (*GetWebfingerResponse) ProtoReflect

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

func (*GetWebfingerResponse) Reset

func (x *GetWebfingerResponse) Reset()

func (*GetWebfingerResponse) String

func (x *GetWebfingerResponse) String() string
type GetWebfingerResponseLink struct {
	Rel  string `protobuf:"bytes,1,opt,name=rel,proto3" json:"rel,omitempty"`
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Href string `protobuf:"bytes,3,opt,name=href,proto3" json:"href,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWebfingerResponseLink) Descriptor deprecated

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

Deprecated: Use GetWebfingerResponseLink.ProtoReflect.Descriptor instead.

func (*GetWebfingerResponseLink) GetHref

func (x *GetWebfingerResponseLink) GetHref() string

func (*GetWebfingerResponseLink) GetRel

func (x *GetWebfingerResponseLink) GetRel() string

func (*GetWebfingerResponseLink) GetType

func (x *GetWebfingerResponseLink) GetType() string

func (*GetWebfingerResponseLink) ProtoMessage

func (*GetWebfingerResponseLink) ProtoMessage()

func (*GetWebfingerResponseLink) ProtoReflect

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

func (*GetWebfingerResponseLink) Reset

func (x *GetWebfingerResponseLink) Reset()

func (*GetWebfingerResponseLink) String

func (x *GetWebfingerResponseLink) String() string

type PublicClient

type PublicClient interface {
	// Get the instance details of the current instance.
	GetInstance(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetInstanceResponse, error)
	// CreateAccounts creates new accounts.
	CreateAccounts(ctx context.Context, in *CreateAccountsRequest, opts ...grpc.CallOption) (*CreateAccountsResponse, error)
	// Open API routing for the ActivityPub protocol.
	// ActivityPub https://www.w3.org/TR/activitypub/
	// HTTP API for public query of ActivityPub.
	// ActivityPub WebFinger https://github.com/w3c/activitypub/issues/194 .
	GetWebfinger(ctx context.Context, in *GetWebfingerRequest, opts ...grpc.CallOption) (*GetWebfingerResponse, error)
	// Get the actors in the activityPub protocol.
	// https://www.w3.org/TR/activitypub/#actor-objects
	GetActor(ctx context.Context, in *GetActorRequest, opts ...grpc.CallOption) (*GetActorResponse, error)
	// GetChannel Get public information about the channel,
	// which is essentially an Actor with a differentiated type at different URLs (/c/ and /u/).
	// https://www.w3.org/TR/activitystreams-vocabulary/#dfn-service
	GetChannel(ctx context.Context, in *GetChannelRequest, opts ...grpc.CallOption) (*GetActorResponse, error)
}

PublicClient is the client API for Public 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 NewPublicClient

func NewPublicClient(cc grpc.ClientConnInterface) PublicClient

type PublicServer

type PublicServer interface {
	// Get the instance details of the current instance.
	GetInstance(context.Context, *emptypb.Empty) (*GetInstanceResponse, error)
	// CreateAccounts creates new accounts.
	CreateAccounts(context.Context, *CreateAccountsRequest) (*CreateAccountsResponse, error)
	// Open API routing for the ActivityPub protocol.
	// ActivityPub https://www.w3.org/TR/activitypub/
	// HTTP API for public query of ActivityPub.
	// ActivityPub WebFinger https://github.com/w3c/activitypub/issues/194 .
	GetWebfinger(context.Context, *GetWebfingerRequest) (*GetWebfingerResponse, error)
	// Get the actors in the activityPub protocol.
	// https://www.w3.org/TR/activitypub/#actor-objects
	GetActor(context.Context, *GetActorRequest) (*GetActorResponse, error)
	// GetChannel Get public information about the channel,
	// which is essentially an Actor with a differentiated type at different URLs (/c/ and /u/).
	// https://www.w3.org/TR/activitystreams-vocabulary/#dfn-service
	GetChannel(context.Context, *GetChannelRequest) (*GetActorResponse, error)
}

PublicServer is the server API for Public service. All implementations should embed UnimplementedPublicServer for forward compatibility

type UnimplementedPublicServer

type UnimplementedPublicServer struct {
}

UnimplementedPublicServer should be embedded to have forward compatible implementations.

func (UnimplementedPublicServer) CreateAccounts

func (UnimplementedPublicServer) GetActor

func (UnimplementedPublicServer) GetChannel

func (UnimplementedPublicServer) GetInstance

func (UnimplementedPublicServer) GetWebfinger

type UnsafePublicServer

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

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

Jump to

Keyboard shortcuts

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