usememos/memos
1
1
Fork 0
mirror of https://github.com/usememos/memos.git synced 2024-12-29 00:21:52 +08:00
Code Issues Projects Releases Packages Wiki Activity

chore: tweak comments

Browse source
This commit is contained in:
Steven 2024-05-20 22:15:51 +08:00
parent 613c9e9416
commit f54b05a521
16 changed files with 45 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/apidocs.swagger.yaml
View file

@ -310,7 +310,7 @@ paths:
- name: filter
description: |-
Filter is used to filter memos returned in the list.
Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query
required: false
type: string
@ -410,7 +410,7 @@ paths:
- name: filter
description: |-
Filter is used to filter memos returned.
Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query
required: false
type: string
@ -545,7 +545,7 @@ paths:
- name: filter
description: |-
Filter is used to filter users returned in the list.
Format: "username == frank"
Format: "username == 'frank'"
in: query
required: false
type: string
@ -1517,7 +1517,7 @@ paths:
- name: filter
description: |-
Filter is used to filter memos.
Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query
required: false
type: string

6
proto/api/v1/memo_service.proto
View file

@ -205,7 +205,7 @@ message ListMemosRequest {
string page_token = 2;
// Filter is used to filter memos returned in the list.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
string filter = 3;
}
@ -219,7 +219,7 @@ message ListMemosResponse {
message SearchMemosRequest {
// Filter is used to filter memos returned.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
string filter = 1;
}
@ -266,7 +266,7 @@ message ListMemoTagsRequest {
string parent = 1;
// Filter is used to filter memos.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
string filter = 2;
}

2
proto/api/v1/user_service.proto
View file

@ -129,7 +129,7 @@ message ListUsersResponse {
message SearchUsersRequest {
// Filter is used to filter users returned in the list.
// Format: "username == frank"
// Format: "username == 'frank'"
string filter = 1;
}

6
proto/gen/api/v1/activity_service.pb.gw.go
View file

@ -120,21 +120,21 @@ func RegisterActivityServiceHandlerServer(ctx context.Context, mux *runtime.Serv
// RegisterActivityServiceHandlerFromEndpoint is same as RegisterActivityServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterActivityServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/auth_service.pb.gw.go
View file

@ -312,21 +312,21 @@ func RegisterAuthServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux
// RegisterAuthServiceHandlerFromEndpoint is same as RegisterAuthServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterAuthServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/idp_service.pb.gw.go
View file

@ -416,21 +416,21 @@ func RegisterIdentityProviderServiceHandlerServer(ctx context.Context, mux *runt
// RegisterIdentityProviderServiceHandlerFromEndpoint is same as RegisterIdentityProviderServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterIdentityProviderServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/inbox_service.pb.gw.go
View file

@ -306,21 +306,21 @@ func RegisterInboxServiceHandlerServer(ctx context.Context, mux *runtime.ServeMu
// RegisterInboxServiceHandlerFromEndpoint is same as RegisterInboxServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterInboxServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/markdown_service.pb.gw.go
View file

@ -206,21 +206,21 @@ func RegisterMarkdownServiceHandlerServer(ctx context.Context, mux *runtime.Serv
// RegisterMarkdownServiceHandlerFromEndpoint is same as RegisterMarkdownServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterMarkdownServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/memo_service.pb.go
View file

@ -315,7 +315,7 @@ type ListMemosRequest struct {
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter is used to filter memos returned in the list.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
}
@ -435,7 +435,7 @@ type SearchMemosRequest struct {
unknownFields protoimpl.UnknownFields
// Filter is used to filter memos returned.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
}
@ -831,7 +831,7 @@ type ListMemoTagsRequest struct {
// Format: memos/{id}. Use "memos/-" to list all tags.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Filter is used to filter memos.
// Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']"
// Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
}

6
proto/gen/api/v1/memo_service.pb.gw.go
View file

@ -1712,21 +1712,21 @@ func RegisterMemoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux
// RegisterMemoServiceHandlerFromEndpoint is same as RegisterMemoServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterMemoServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/resource_service.pb.gw.go
View file

@ -554,21 +554,21 @@ func RegisterResourceServiceHandlerServer(ctx context.Context, mux *runtime.Serv
// RegisterResourceServiceHandlerFromEndpoint is same as RegisterResourceServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterResourceServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

2
proto/gen/api/v1/user_service.pb.go
View file

@ -306,7 +306,7 @@ type SearchUsersRequest struct {
unknownFields protoimpl.UnknownFields
// Filter is used to filter users returned in the list.
// Format: "username == frank"
// Format: "username == 'frank'"
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
}

6
proto/gen/api/v1/user_service.pb.gw.go
View file

@ -1033,21 +1033,21 @@ func RegisterUserServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux
// RegisterUserServiceHandlerFromEndpoint is same as RegisterUserServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterUserServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/webhook_service.pb.gw.go
View file

@ -434,21 +434,21 @@ func RegisterWebhookServiceHandlerServer(ctx context.Context, mux *runtime.Serve
// RegisterWebhookServiceHandlerFromEndpoint is same as RegisterWebhookServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterWebhookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/workspace_service.pb.gw.go
View file

@ -86,21 +86,21 @@ func RegisterWorkspaceServiceHandlerServer(ctx context.Context, mux *runtime.Ser
// RegisterWorkspaceServiceHandlerFromEndpoint is same as RegisterWorkspaceServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterWorkspaceServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()

6
proto/gen/api/v1/workspace_setting_service.pb.gw.go
View file

@ -205,21 +205,21 @@ func RegisterWorkspaceSettingServiceHandlerServer(ctx context.Context, mux *runt
// RegisterWorkspaceSettingServiceHandlerFromEndpoint is same as RegisterWorkspaceSettingServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterWorkspaceSettingServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.DialContext(ctx, endpoint, opts...)
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
grpclog.Errorf("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()