API Reference

• 1. Info
• 2. Paths
  • SolidusBridge
• 3. Components
  • 3.1 Schemas
  • 3.2 Enums
• 4. Scalar Value Types

---

1. Info

• Title: gRPC API
• Version: 1.0.0
• Description: This documentation is generated from protobuf files using protoc-gen-doc.

---

2. Paths

SolidusBridge

UploadFile

• Summary: 上传文件
• Method: UploadFile
• Endpoint: solidus_bridge.SolidusBridge/UploadFile
• Request:
  • Content-Type: application/grpc
  • Schema: UploadFileStream
• Response:
  • Content-Type: application/grpc
  • Schema: UploadFileResponse

ListFiles

• Summary: 查询文件
• Method: ListFiles
• Endpoint: solidus_bridge.SolidusBridge/ListFiles
• Request:
  • Content-Type: application/grpc
  • Schema: Empty
• Response:
  • Content-Type: application/grpc
  • Schema: ListFilesResponse

---

3. Components

3.1 Schemas

FileEntries

Field	Type	Description
filePath	string	none
lastModified	double	none

ListFilesResponse

Field	Type	Description
msg	string	none
entries	FileEntries	none

UploadFileRequest

文件元数据

Field	Type	Description
fileType	FileType	文件类型
fileName	string	文件名称

UploadFileResponse

Field	Type	Description

UploadFileStream

文件上传流中的每一块

Field	Type	Description
chunk.metadata	UploadFileRequest	文件元数据，发送一次
chunk.fileChunk	bytes	文件分块，可能发送多次

3.2 Enums

FileType

Name	Number	Description
unknown	0	none
private_order	1	order files using v1 schema
private_order_v2	2	order files using v2 and v2.1 schemas
private_execution	3	execution files using v1 schema
private_execution_v2	4	execution files using v2 schema
linked_private_execution_v2	5	execution files using v2.1 schema

---

4. Scalar Value Types

Proto Type	Go Type	C++ Type	Java Type	Python Type	Notes
double	float64	double	double	float
float	float32	float	float	float
int32	int32	int32	int	int	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int64	int64	int64	long	int/long	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
uint32	uint32	uint32	int	int/long	Uses variable-length encoding.
uint64	uint64	uint64	long	int/long	Uses variable-length encoding.
sint32	int32	int32	int	int	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
sint64	int64	int64	long	int/long	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
fixed32	uint32	uint32	int	int	Always four bytes. More efficient than uint32 if values are often greater than 2^28.
fixed64	uint64	uint64	long	int/long	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.
sfixed32	int32	int32	int	int	Always four bytes.
sfixed64	int64	int64	long	int/long	Always eight bytes.
bool	bool	bool	boolean	boolean
string	string	string	String	str/unicode	A string must always contain UTF-8 encoded or 7-bit ASCII text.
bytes	[]byte	string	ByteString	str	May contain any arbitrary sequence of bytes.

---