Search API Reference

search/v1/record_query.proto

RecordQuery

A query to match the record against during discovery. For example: { type: RECORD_QUERY_TYPE_SKILL_NAME, value: "Natural Language Processing" } { type: RECORD_QUERY_TYPE_LOCATOR, value: "docker-image:https://example.com/docker-image" }

Field	Type	Label	Description
type	RecordQueryType		The type of the query to match against.
value	string		The query value to match against.

RecordQueryType

Defines a list of supported record query types.

Name	Number	Description
RECORD_QUERY_TYPE_UNSPECIFIED	0	Unspecified query type.
RECORD_QUERY_TYPE_NAME	1	Query for an agent name.
RECORD_QUERY_TYPE_VERSION	2	Query for an agent version.
RECORD_QUERY_TYPE_SKILL_ID	3	Query for a skill ID.
RECORD_QUERY_TYPE_SKILL_NAME	4	Query for a skill name.
RECORD_QUERY_TYPE_LOCATOR	5	Query for a locator.
RECORD_QUERY_TYPE_EXTENSION	6	Query for an extension.

search/v1/search_service.proto

SearchRequest

Field	Type	Label	Description
queries	RecordQuery	repeated	List of queries to match against the records.
limit	uint32	optional	Optional limit on the number of results to return.
offset	uint32	optional	Optional offset for pagination of results.

SearchResponse

Field	Type	Label	Description
record_cid	string		The CID of the record that matches the search criteria.

SearchService

Method Name	Request Type	Response Type	Description
Search	SearchRequest	SearchResponse stream	List records that this peer is currently providing that match the given parameters. This operation does not interact with the network.

Scalar Value Types

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