proto

api.showonce.v1 API Documentation

Table of Contents

• proto/service.proto

  • Services

    • PrivateService
    • PublicService

  • Messages

    • ItemData
    • ItemId
    • ItemList
    • ItemMeta
    • ItemMetaWithId
    • NewItemRequest
    • Stats
    • StatsResponse

  • Enums

    • ItemStatus

• Scalar Value Types

Top

proto/service.proto

PrivateService

Private

Method Name	Request Type	Response Type	Description
NewItem	NewItemRequest	ItemId	создать секрет
GetItems	.google.protobuf.Empty	ItemList	вернуть список своих секретов
GetStats	.google.protobuf.Empty	StatsResponse	общая статистика по количеству секретов

PublicService

Method Name	Request Type	Response Type	Description
GetMetadata	ItemId	ItemMeta	вернуть метаданные секрета по id
GetData	ItemId	ItemData	вернуть текст секрета по id

ItemData

Данные секрета

Field	Type	Label	Description
data	string		Данные секрета

ItemId

Идентификатор (ULID)

Field	Type	Label	Description
id	string

ItemList

Список секретов

Field	Type	Label	Description
items	ItemMetaWithId	repeated	Список секретов

ItemMeta

Метаданные секрета

Field	Type	Label	Description
title	string		описание
group	string		идентификатор для группировки
owner	string		автор
status	ItemStatus		статус
created_at	google.protobuf.Timestamp		момент создания
modified_at	google.protobuf.Timestamp		первоначально - срок автоудаления, после показа - момент показа

ItemMetaWithId

Метаданные секрета с идентификатором

Field	Type	Label	Description
id	string		идентификатор
meta	ItemMeta		метаданные

NewItemRequest

Аргументы запроса на создание

Field	Type	Label	Description
title	string		описание
group	string		идентификатор для группировки
expire	string		срок актуальности
expire_unit	string		единица срока актуальности ("d" - день, остальные варианты - как в go: "ns", "us" (or "µs"), "ms", "s", "m", "h")
data	string		текст секрета, удаляется после первого показа

Stats

Статистика по секретам

Field	Type	Label	Description
total	int32		Всего в хранилище
wait	int32		Готово к прочтению
read	int32		Прочитано
expired	int32		Истек срок актуальности

StatsResponse

Ответ на запрос статистика

Field	Type	Label	Description
my	Stats		Данные по текущему пользователю
other	Stats		Данные по остальным пользователям

ItemStatus

Статус секрета

Name	Number	Description
UNKNOWN	0	A Standard tournament
WAIT	1	Готово к прочтению
READ	2	Прочитано
EXPIRED	3	Истек срок актуальности
CLEARED	4	Удалено

Scalar Value Types

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