generated from VLADIMIR/template
add Upload and Download files
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
// Copyright 2026 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.api;
|
||||
|
||||
import "google/protobuf/any.proto";
|
||||
|
||||
option go_package = "google.golang.org/genproto/googleapis/api/httpbody;httpbody";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "HttpBodyProto";
|
||||
option java_package = "com.google.api";
|
||||
option objc_class_prefix = "GAPI";
|
||||
|
||||
// Message that represents an arbitrary HTTP body. It should only be used for
|
||||
// payload formats that can't be represented as JSON, such as raw binary or
|
||||
// an HTML page.
|
||||
//
|
||||
//
|
||||
// This message can be used both in streaming and non-streaming API methods in
|
||||
// the request as well as the response.
|
||||
//
|
||||
// It can be used as a top-level request field, which is convenient if one
|
||||
// wants to extract parameters from either the URL or HTTP template into the
|
||||
// request fields and also want access to the raw HTTP body.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// message GetResourceRequest {
|
||||
// // A unique request id.
|
||||
// string request_id = 1;
|
||||
//
|
||||
// // The raw HTTP body is bound to this field.
|
||||
// google.api.HttpBody http_body = 2;
|
||||
//
|
||||
// }
|
||||
//
|
||||
// service ResourceService {
|
||||
// rpc GetResource(GetResourceRequest)
|
||||
// returns (google.api.HttpBody);
|
||||
// rpc UpdateResource(google.api.HttpBody)
|
||||
// returns (google.protobuf.Empty);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// Example with streaming methods:
|
||||
//
|
||||
// service CaldavService {
|
||||
// rpc GetCalendar(stream google.api.HttpBody)
|
||||
// returns (stream google.api.HttpBody);
|
||||
// rpc UpdateCalendar(stream google.api.HttpBody)
|
||||
// returns (stream google.api.HttpBody);
|
||||
//
|
||||
// }
|
||||
//
|
||||
// Use of this type only changes how the request and response bodies are
|
||||
// handled, all other features will continue to work unchanged.
|
||||
message HttpBody {
|
||||
// The HTTP Content-Type header value specifying the content type of the body.
|
||||
string content_type = 1;
|
||||
|
||||
// The HTTP request/response body as raw binary.
|
||||
bytes data = 2;
|
||||
|
||||
// Application specific response metadata. Must be set in the first response
|
||||
// for streaming APIs.
|
||||
repeated google.protobuf.Any extensions = 3;
|
||||
}
|
||||
+73
-3
@@ -5,6 +5,7 @@ package crabs.evening_detective_server;
|
||||
import "google/api/annotations.proto";
|
||||
import "google/protobuf/timestamp.proto";
|
||||
import "protoc-gen-openapiv2/options/annotations.proto";
|
||||
import "google/api/httpbody.proto";
|
||||
|
||||
option go_package = "pkg/proto";
|
||||
|
||||
@@ -42,6 +43,7 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
summary: "Проверить доступность";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -53,6 +55,7 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
summary: "Проверить обработку данных";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -65,6 +68,8 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
tags : "Регистрация и вход";
|
||||
summary: "Зарегистрироваться";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -77,6 +82,8 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
tags : "Регистрация и вход";
|
||||
summary: "Обновить пароль";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -89,6 +96,8 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
tags : "Регистрация и вход";
|
||||
summary: "Войти и получить токена доступа";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -101,6 +110,8 @@ service EveningDetectiveServer {
|
||||
security: {
|
||||
security_requirement: {}
|
||||
}
|
||||
tags : "Регистрация и вход";
|
||||
summary: "Обновить токена доступа";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -108,18 +119,30 @@ service EveningDetectiveServer {
|
||||
option (google.api.http) = {
|
||||
get: "/api/users"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Пользователи";
|
||||
summary: "Получить всех пользователей";
|
||||
};
|
||||
}
|
||||
|
||||
rpc GetUserById(GetUserByIdReq) returns (GetUserByIdRsp) {
|
||||
option (google.api.http) = {
|
||||
get: "/api/users/{id}"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Пользователи";
|
||||
summary: "Получить пользователя по id";
|
||||
};
|
||||
}
|
||||
|
||||
rpc GetMe(GetMeReq) returns (GetMeRsp) {
|
||||
option (google.api.http) = {
|
||||
get: "/api/users/me"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Пользователи";
|
||||
summary: "Получить информацию о себе";
|
||||
};
|
||||
}
|
||||
|
||||
rpc AddUserRole(AddUserRoleReq) returns (AddUserRoleRsp) {
|
||||
@@ -127,12 +150,20 @@ service EveningDetectiveServer {
|
||||
post: "/api/users/{id}/role/add"
|
||||
body: "*"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Пользователи";
|
||||
summary: "Добавить пользователю роль";
|
||||
};
|
||||
}
|
||||
|
||||
rpc DeleteUserRole(DeleteUserRoleReq) returns (DeleteUserRoleRsp) {
|
||||
option (google.api.http) = {
|
||||
post: "/api/users/{id}/role/delete"
|
||||
body : "*"
|
||||
body: "*"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Пользователи";
|
||||
summary: "Забрать у пользователя роль";
|
||||
};
|
||||
}
|
||||
|
||||
@@ -140,6 +171,31 @@ service EveningDetectiveServer {
|
||||
option (google.api.http) = {
|
||||
get: "/api/ui/permissions"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Доступы";
|
||||
summary: "Получить список доступных элементов интерфейса";
|
||||
};
|
||||
}
|
||||
|
||||
rpc UploadFile(UploadFileReq) returns (UploadFileRsp) {
|
||||
option (google.api.http) = {
|
||||
post: "/api/files/upload"
|
||||
body: "*"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Файлы";
|
||||
summary: "Загрузить файл";
|
||||
};
|
||||
}
|
||||
|
||||
rpc DownloadFile(DownloadFileReq) returns (google.api.HttpBody) {
|
||||
option (google.api.http) = {
|
||||
get: "/api/files/{filename}"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
tags : "Файлы";
|
||||
summary: "Получить файл";
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -246,6 +302,20 @@ message DeleteUserRoleRsp {
|
||||
message GetPermissionsReq {}
|
||||
|
||||
message GetPermissionsRsp {
|
||||
string error = 1;
|
||||
repeated string permissions = 2;
|
||||
string error = 1;
|
||||
repeated string permissions = 2;
|
||||
}
|
||||
|
||||
message UploadFileReq {
|
||||
string filename = 1;
|
||||
bytes data = 2;
|
||||
}
|
||||
|
||||
message UploadFileRsp {
|
||||
string error = 1;
|
||||
string filename = 2;
|
||||
}
|
||||
|
||||
message DownloadFileReq {
|
||||
string filename = 1;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user