api

package module
v0.0.0-...-d3bb3ff Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	Term_name = map[int32]string{
		0: "TERM_UNDEFINED",
		1: "TERM_OTHER",
		2: "TERM_WEEK",
		3: "TERM_TODAY",
	}
	Term_value = map[string]int32{
		"TERM_UNDEFINED": 0,
		"TERM_OTHER":     1,
		"TERM_WEEK":      2,
		"TERM_TODAY":     3,
	}
)

Enum value maps for Term.

View Source
var (
	Status_name = map[int32]string{
		0: "STATUS_UNDEFINED",
		1: "STATUS_DONE",
		2: "STATUS_NOT_DONE",
		3: "STATUS_CLOSED",
	}
	Status_value = map[string]int32{
		"STATUS_UNDEFINED": 0,
		"STATUS_DONE":      1,
		"STATUS_NOT_DONE":  2,
		"STATUS_CLOSED":    3,
	}
)

Enum value maps for Status.

View Source
var File_hisho_core_service_proto protoreflect.FileDescriptor

Functions

func RegisterHishoCoreServiceHandler

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

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

func RegisterHishoCoreServiceHandlerClient

func RegisterHishoCoreServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HishoCoreServiceClient) error

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

func RegisterHishoCoreServiceHandlerFromEndpoint

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

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

func RegisterHishoCoreServiceHandlerServer

func RegisterHishoCoreServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HishoCoreServiceServer) error

RegisterHishoCoreServiceHandlerServer registers the http handlers for service HishoCoreService to "mux". UnaryRPC :call HishoCoreServiceServer 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 RegisterHishoCoreServiceHandlerFromEndpoint instead.

func RegisterHishoCoreServiceServer

func RegisterHishoCoreServiceServer(s *grpc.Server, srv HishoCoreServiceServer)

Types

type AddTaskRequest

type AddTaskRequest struct {
	Title   string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Term    Term   `protobuf:"varint,2,opt,name=term,proto3,enum=hisho_core_service.Term" json:"term,omitempty"`
	IsGreen bool   `protobuf:"varint,3,opt,name=is_green,json=isGreen,proto3" json:"is_green,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTaskRequest) Descriptor deprecated

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

Deprecated: Use AddTaskRequest.ProtoReflect.Descriptor instead.

func (*AddTaskRequest) GetIsGreen

func (x *AddTaskRequest) GetIsGreen() bool

func (*AddTaskRequest) GetTerm

func (x *AddTaskRequest) GetTerm() Term

func (*AddTaskRequest) GetTitle

func (x *AddTaskRequest) GetTitle() string

func (*AddTaskRequest) ProtoMessage

func (*AddTaskRequest) ProtoMessage()

func (*AddTaskRequest) ProtoReflect

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

func (*AddTaskRequest) Reset

func (x *AddTaskRequest) Reset()

func (*AddTaskRequest) String

func (x *AddTaskRequest) String() string

type ChangeTaskStatusRequest

type ChangeTaskStatusRequest struct {
	Id     uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	From   Status `protobuf:"varint,2,opt,name=from,proto3,enum=hisho_core_service.Status" json:"from,omitempty"`
	To     Status `protobuf:"varint,3,opt,name=to,proto3,enum=hisho_core_service.Status" json:"to,omitempty"`
	Reason string `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

func (*ChangeTaskStatusRequest) Descriptor deprecated

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

Deprecated: Use ChangeTaskStatusRequest.ProtoReflect.Descriptor instead.

func (*ChangeTaskStatusRequest) GetFrom

func (x *ChangeTaskStatusRequest) GetFrom() Status

func (*ChangeTaskStatusRequest) GetId

func (x *ChangeTaskStatusRequest) GetId() uint64

func (*ChangeTaskStatusRequest) GetReason

func (x *ChangeTaskStatusRequest) GetReason() string

func (*ChangeTaskStatusRequest) GetTo

func (x *ChangeTaskStatusRequest) GetTo() Status

func (*ChangeTaskStatusRequest) ProtoMessage

func (*ChangeTaskStatusRequest) ProtoMessage()

func (*ChangeTaskStatusRequest) ProtoReflect

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

func (*ChangeTaskStatusRequest) Reset

func (x *ChangeTaskStatusRequest) Reset()

func (*ChangeTaskStatusRequest) String

func (x *ChangeTaskStatusRequest) String() string

type HishoCoreServiceClient

type HishoCoreServiceClient interface {
	// ping pong
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
	// get tasks for terms (today, week, other etc.)
	GetTasksByTerm(ctx context.Context, in *TaskRequest, opts ...grpc.CallOption) (*TasksResponse, error)
	// add new task
	AddTask(ctx context.Context, in *AddTaskRequest, opts ...grpc.CallOption) (*Task, error)
	// set task status
	ChangeTaskStatus(ctx context.Context, in *ChangeTaskStatusRequest, opts ...grpc.CallOption) (*Task, error)
	// edit task
	EditTask(ctx context.Context, in *Task, opts ...grpc.CallOption) (*Task, error)
}

HishoCoreServiceClient is the client API for HishoCoreService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type HishoCoreServiceServer

type HishoCoreServiceServer interface {
	// ping pong
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	// get tasks for terms (today, week, other etc.)
	GetTasksByTerm(context.Context, *TaskRequest) (*TasksResponse, error)
	// add new task
	AddTask(context.Context, *AddTaskRequest) (*Task, error)
	// set task status
	ChangeTaskStatus(context.Context, *ChangeTaskStatusRequest) (*Task, error)
	// edit task
	EditTask(context.Context, *Task) (*Task, error)
}

HishoCoreServiceServer is the server API for HishoCoreService service.

type Page

type Page struct {
	Number int32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
	Limit  int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*Page) Descriptor deprecated

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

Deprecated: Use Page.ProtoReflect.Descriptor instead.

func (*Page) GetLimit

func (x *Page) GetLimit() int32

func (*Page) GetNumber

func (x *Page) GetNumber() int32

func (*Page) ProtoMessage

func (*Page) ProtoMessage()

func (*Page) ProtoReflect

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

func (*Page) Reset

func (x *Page) Reset()

func (*Page) String

func (x *Page) String() string

type PingRequest

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

func (*PingRequest) Descriptor deprecated

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

Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.

func (*PingRequest) GetValue

func (x *PingRequest) GetValue() string

func (*PingRequest) ProtoMessage

func (*PingRequest) ProtoMessage()

func (*PingRequest) ProtoReflect

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

func (*PingRequest) Reset

func (x *PingRequest) Reset()

func (*PingRequest) String

func (x *PingRequest) String() string

type PingResponse

type PingResponse struct {
	Code  int64  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*PingResponse) Descriptor deprecated

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

Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.

func (*PingResponse) GetCode

func (x *PingResponse) GetCode() int64

func (*PingResponse) GetValue

func (x *PingResponse) GetValue() string

func (*PingResponse) ProtoMessage

func (*PingResponse) ProtoMessage()

func (*PingResponse) ProtoReflect

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

func (*PingResponse) Reset

func (x *PingResponse) Reset()

func (*PingResponse) String

func (x *PingResponse) String() string

type Status

type Status int32
const (
	Status_STATUS_UNDEFINED Status = 0
	Status_STATUS_DONE      Status = 1
	Status_STATUS_NOT_DONE  Status = 2
	Status_STATUS_CLOSED    Status = 3
)

func (Status) Descriptor

func (Status) Descriptor() protoreflect.EnumDescriptor

func (Status) Enum

func (x Status) Enum() *Status

func (Status) EnumDescriptor deprecated

func (Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use Status.Descriptor instead.

func (Status) Number

func (x Status) Number() protoreflect.EnumNumber

func (Status) String

func (x Status) String() string

func (Status) Type

func (Status) Type() protoreflect.EnumType

type Task

type Task struct {
	Id           uint64                 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Title        string                 `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	Term         Term                   `protobuf:"varint,3,opt,name=term,proto3,enum=hisho_core_service.Term" json:"term,omitempty"`
	CreatedAt    *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt    *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	ClosedAt     *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=closed_at,json=closedAt,proto3" json:"closed_at,omitempty"`
	IsGreen      bool                   `protobuf:"varint,7,opt,name=is_green,json=isGreen,proto3" json:"is_green,omitempty"`
	ClosedReason string                 `protobuf:"bytes,8,opt,name=closed_reason,json=closedReason,proto3" json:"closed_reason,omitempty"`
	Status       Status                 `protobuf:"varint,9,opt,name=status,proto3,enum=hisho_core_service.Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*Task) Descriptor deprecated

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

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetClosedAt

func (x *Task) GetClosedAt() *timestamppb.Timestamp

func (*Task) GetClosedReason

func (x *Task) GetClosedReason() string

func (*Task) GetCreatedAt

func (x *Task) GetCreatedAt() *timestamppb.Timestamp

func (*Task) GetId

func (x *Task) GetId() uint64

func (*Task) GetIsGreen

func (x *Task) GetIsGreen() bool

func (*Task) GetStatus

func (x *Task) GetStatus() Status

func (*Task) GetTerm

func (x *Task) GetTerm() Term

func (*Task) GetTitle

func (x *Task) GetTitle() string

func (*Task) GetUpdatedAt

func (x *Task) GetUpdatedAt() *timestamppb.Timestamp

func (*Task) ProtoMessage

func (*Task) ProtoMessage()

func (*Task) ProtoReflect

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

func (*Task) Reset

func (x *Task) Reset()

func (*Task) String

func (x *Task) String() string

type TaskRequest

type TaskRequest struct {
	Term Term  `protobuf:"varint,1,opt,name=term,proto3,enum=hisho_core_service.Term" json:"term,omitempty"`
	Page *Page `protobuf:"bytes,2,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*TaskRequest) Descriptor deprecated

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

Deprecated: Use TaskRequest.ProtoReflect.Descriptor instead.

func (*TaskRequest) GetPage

func (x *TaskRequest) GetPage() *Page

func (*TaskRequest) GetTerm

func (x *TaskRequest) GetTerm() Term

func (*TaskRequest) ProtoMessage

func (*TaskRequest) ProtoMessage()

func (*TaskRequest) ProtoReflect

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

func (*TaskRequest) Reset

func (x *TaskRequest) Reset()

func (*TaskRequest) String

func (x *TaskRequest) String() string

type TasksResponse

type TasksResponse struct {
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

func (*TasksResponse) Descriptor deprecated

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

Deprecated: Use TasksResponse.ProtoReflect.Descriptor instead.

func (*TasksResponse) GetTasks

func (x *TasksResponse) GetTasks() []*Task

func (*TasksResponse) ProtoMessage

func (*TasksResponse) ProtoMessage()

func (*TasksResponse) ProtoReflect

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

func (*TasksResponse) Reset

func (x *TasksResponse) Reset()

func (*TasksResponse) String

func (x *TasksResponse) String() string

type Term

type Term int32
const (
	Term_TERM_UNDEFINED Term = 0
	Term_TERM_OTHER     Term = 1
	Term_TERM_WEEK      Term = 2
	Term_TERM_TODAY     Term = 3
)

func (Term) Descriptor

func (Term) Descriptor() protoreflect.EnumDescriptor

func (Term) Enum

func (x Term) Enum() *Term

func (Term) EnumDescriptor deprecated

func (Term) EnumDescriptor() ([]byte, []int)

Deprecated: Use Term.Descriptor instead.

func (Term) Number

func (x Term) Number() protoreflect.EnumNumber

func (Term) String

func (x Term) String() string

func (Term) Type

func (Term) Type() protoreflect.EnumType

type UnimplementedHishoCoreServiceServer

type UnimplementedHishoCoreServiceServer struct {
}

UnimplementedHishoCoreServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHishoCoreServiceServer) AddTask

func (*UnimplementedHishoCoreServiceServer) ChangeTaskStatus

func (*UnimplementedHishoCoreServiceServer) EditTask

func (*UnimplementedHishoCoreServiceServer) GetTasksByTerm

func (*UnimplementedHishoCoreServiceServer) Ping

Jump to

Keyboard shortcuts

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