Skip to content
This repository has been archived by the owner on Aug 4, 2018. It is now read-only.

Package search

Fingercomp edited this page Nov 23, 2016 · 4 revisions

The GET /packages view accepts additional query parameters to filter the results.

Some parameters can be specified only once, while other can be specified several times (?param=value&param=another-value). Multiple values are collected into a list, and then processed.

You MUST NOT provide multiple values if only one is required.

Some parameters accept a so-called "search phrase". Basically, it's a string of "search words", separated with spaces. For example, word1 word2 word3. Search words that contain spaces must be encosed in quotes. E.g., word1 "word2-1 word2-2" word3.

The table below lists search params.

  • The column type indicates what kind of arguments a param needs. one means one plain value, mtp means multiple values, and sph means a search phrase.
Param name Type Description
name one Package name
description sph Description
short_description sph Short description
authors sph Program authors
owners mtp Package owners
license one Program license
tags mtp Package tags
file_url mtp URL of a file of the latest version
file_dir mtp Directory of a file of the latest version
file_name mtp File name of a file of the latest version
dependency mtp Param format: name[:<version>[:<type>]]. Packages that list the value as a dependency of the latest version
screen_url mtp Image URL
screen_desc sph Image description
q sph Generic search query (occurence of search words in package documents).

Changes

Version Changes
3.1.0 Added params owners, q.

See Also