Schemas — daemonports API

`SystemPath`

The path of a system other than FreeBSD.

Type: string

One of "openbsd", "netbsd", "dragonfly", "midnightbsd", "hardenedbsd", "ghostbsd", "opnsense".

`Index`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`asOf`	`string`	The newest commit date among the ports.
`systems` (required)	array of `SystemSummary`
`newPorts`	`array of object`	The most recently added ports.
`latestVulnerabilities`	array of `SiteVulnerability`
`docs`	`string (uri)`

`SystemSummary`

Type: object

Property	Type	Description
`id`	`string`
`label`	`string`
`base`	`string`	Its pages' path; empty for FreeBSD, at the root.
`count`	`integer`	Ports with a page of their own.
`install`	array of `Install`
`parent`	`string`	The system a derivative is built from.
`shared`	`integer`	A derivative's ports that are its parent's, listed on the parent's pages.

`Install`

Type: object

Property	Type	Description
`label`	`string`
`format`	`string`	printf format; %s is the port's `field`
`field`	`string`

`Port`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`system` (required)	`string`
`systemLabel`	`string`
`origin` (required)	`string`
`name`	`string`
`version` (required)	`string`	The tree's own version, revisions included.
`pkgName`	`string`
`comment`	`string`
`description`	`string`
`maintainer`	`string`
`categories`	`array of string`
`www`	`string \| null (uri)`
`license`	`array of string \| null`
`repository`	`string`
`added`	`string \| null`	When the port was added
`lastUpdate`	`string \| null`	The last commit to the port.
`status`	array of `Notice`
`vulnerabilities`	array of `Vulnerability`	null when none are known; see noVulnData for whether that means anything.
`noVulnData`	`boolean`	The system has no list of vulnerabilities: an empty list is no data, not none known.
`flavors`	`array of object \| null`
`flavors[].pkgName`	`string`
`flavors[].comment`	`string`
`packages`	`array of object \| null`	The version in each package repository; columns as the system's page shows them.
`packages[].repo`	`string`
`packages[].versions`	`array of string`
`buildDepends`	`array of string \| null`	Origins
`runDepends`	`array of string \| null`	Origins
`requiredBy`	`array of string \| null`	Origins
`requiredByCount`	`integer`
`otherSystems`	array of `Row`
`newest`	`boolean`	Its version, as upstream's, is the newest of the systems'.
`newestVersion`	`string \| null`
`compare`	`string \| null`	Its comparison's API path.
`behindSince`	`string \| null (date)`	When not the newest: the first day another system had a newer version. Count the days yourself; the file does not change daily.
`related`	`array of string \| null`	Origins of the same software or family in the same system: one homepage, or one name but for a version or variant.
`dependentCount`	`integer \| null`	For a port with a known vulnerability: the ports that depend on it at any depth, in its system.
`versions`	array of `VersionEvent`	The versions it has had, newest first, at most 10; null when the history holds only the version it had when tracking began.
`html` (required)	`string (uri)`

`Row`

The same software in one system.

Type: object

Property	Type	Description
`system`	`string`
`origin`	`string`
`version`	`string`
`path`	`string`	Its page; empty for a derivative's port that is FreeBSD's.
`matchedBy`	`string`	Present when matched by package name; absent when by origin. One of `"name"`.
`status`	`string`
`maintainer`	`string`
`updated`	`string (date)`
`vulnCount`	`integer`
`noVulnData`	`boolean`
`newest`	`boolean`
`behindSince`	`string (date)`	When not the newest: the first day another row's port had a newer version.

`VersionEvent`

Type: object

Property	Type	Description
`version`	`string`	Upstream's version, as the port's Makefile set it.
`date`	`string (date)`	The day it arrived; absent for the version a port had when tracking began.
`commit`	`string`	The commit that set it

`Freshness`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`scope` (required)	`string`	One of `"overview"`, `"system"`.
`system`	`string \| null`
`systemLabel`	`string \| null`
`asOf` (required)	`string (date)`	The day the counts were made.
`compared`	`integer`	Ports with the same origin in another system.
`newest`	`integer`
`newestPercent`	`integer`
`unknown`	`integer`	Behind since a day the history does not reach.
`medianDays`	`integer`
`buckets`	`array of object \| null`
`buckets[].label`	`string`
`buckets[].count`	`integer`
`buckets[].percent`	`integer`
`buckets[].vulnerable`	`integer`	Of them, those with known vulnerabilities; absent when none. Minimum 1.
`vulnerable`	`integer`	Compared ports with known vulnerabilities; absent when none. Minimum 1.
`mostBehind`	`array of object \| null`
`mostBehind[].origin`	`string`
`mostBehind[].path`	`string`
`mostBehind[].version`	`string`
`mostBehind[].newestVersion`	`string`
`mostBehind[].since`	`string (date)`
`mostBehind[].days`	`integer`
`mostBehind[].vulnCount`	`integer`	Known vulnerabilities of its version; absent when none are known. Minimum 1.
`systems`	`array of object \| null`	The overview's rows, one per system.
`html`	`string (uri)`

`Status`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`status` (required)	`string`	One of `"all"`, `"deprecated"`, `"broken"`, `"ignored"`, `"forbidden"`, `"restricted"`.
`system`	`string \| null`
`systemLabel`	`string \| null`
`ports`	`array of object \| null`
`ports[].origin`	`string`
`ports[].path`	`string`
`ports[].version`	`string`
`ports[].maintainer`	`string`
`ports[].reason`	`string`
`ports[].expires`	`string (date)`
`ports[].requiredByCount`	`integer`
`counts`	`array of object \| null`
`counts[].systemLabel`	`string`
`counts[].counts`	`array of integer`	deprecated, broken, ignored, forbidden, restricted
`counts[].paths`	`array of string`
`html`	`string (uri)`

`Changes`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`scope`	`string`	One of `"all"`, `"system"`, `"day"`.
`system`	`string`	A system id, or all.
`date`	`string \| null (date)`	A day's page: the day.
`prev`	`string \| null`	The day page before.
`next`	`string \| null`	The day page after.
`new`	array of `Change`
`updated`	array of `Change`
`removed`	array of `Change`
`vulnerabilities`	`array of object \| null`	A day's page: advisories published that day for the system's ports (pkgsrc: the day its list first named them).
`vulnerabilities[].title`	`string`
`vulnerabilities[].path`	`string`	Its page on this site.
`vulnerabilities[].url`	`string (uri)`
`vulnerabilities[].ports`	array of `Change`
`fixed`	`array of object \| null`	A day's page: ports that moved to a version outside an advisory's ranges.
`fixed[].title`	`string`
`fixed[].path`	`string`
`fixed[].origin`	`string`
`fixed[].portPath`	`string`
`fixed[].days`	`integer`	After the advisory.
`systemLabel`	`string \| null`
`asOf` (required)	`string (date)`
`days`	`array of object \| null`	A system's page: its days, newest first.
`days[].date`	`string (date)`
`days[].path`	`string`
`days[].new`	`integer`
`days[].updated`	`integer`
`days[].removed`	`integer`
`days[].vulns`	`integer`
`days[].fixed`	`integer`
`summary`	`array of object \| null`	The overview: each system's last week.
`summary[].systemLabel`	`string`
`summary[].path`	`string`
`summary[].new`	`integer`
`summary[].updated`	`integer`
`summary[].removed`	`integer`
`summary[].latest`	`string`
`html`	`string (uri)`

`Change`

Type: object

Property	Type	Description
`origin`	`string`
`path`	`string`	Its page; absent for a port that is gone.
`from`	`string`
`to`	`string`

`Advisory`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`id` (required)	`string`
`title`	`string`
`date`	`string (date)`
`url`	`string (uri)`
`cves`	`array of string \| null`
`summary`	`string \| null`
`packages`	`array of object`
`packages[].name`	`string`
`packages[].ranges`	`string`
`findings` (required)	`array of object`
`findings[].system`	`string`
`findings[].origin`	`string`
`findings[].path`	`string`
`findings[].version`	`string`
`findings[].state`	`string`	vulnerable/fixed where VuXML applies; listed/not listed by pkgsrc's own list; in/out of range: an estimate by version for systems without a list. One of `"vulnerable"`, `"fixed"`, `"listed"`, `"not listed"`, `"in range"`, `"out of range"`.
`findings[].fixedOn`	`string (date)`
`findings[].fixDays`	`integer`
`vulnerable`	`integer`
`fixed`	`integer`
`html`	`string (uri)`

`Advisories`

Type: object

Property	Type	Description
`apiVersion`	`integer`
`kind`	`string`
`asOf`	`string (date)`
`advisories`	`array of object`
`advisories[].path`	`string`
`advisories[].date`	`string (date)`
`advisories[].title`	`string`
`advisories[].cves`	`string`
`advisories[].systems`	`string`	Still vulnerable in.
`advisories[].vulnerable`	`integer`
`advisories[].fixed`	`integer`
`html`	`string (uri)`

`Notice`

Type: object

Property	Type	Description
`kind`	`string`	One of `"Deprecated"`, `"Expires"`, `"Broken"`, `"Ignored"`, `"Forbidden"`, `"Restricted"`.
`text`	`string`

`Vulnerability`

Type: object

Property	Type	Description
`id`	`string`
`topic`	`string`
`date`	`string (date)`
`url`	`string (uri)`

`SiteVulnerability`

Type: allOf Vulnerability & object

`Comparison`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`name` (required)	`string`
`comment`	`string`
`newestVersion`	`string`	As upstream numbers it: _N ,N pN vN nbN dropped.
`systemCount`	`integer`
`systems`	`string`
`lastUpdate`	`string \| null (date)`
`rows` (required)	array of `Row`
`html`	`string (uri)`

`Category`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`name` (required)	`string`
`system`	`string`
`systemLabel`	`string`
`description`	`string`
`virtual`	`boolean`	Its ports live in other categories and list this one as well.
`count`	`integer`
`lastUpdate`	`string \| null`
`ports` (required)	`array of object`
`ports[].origin`	`string`
`ports[].version`	`string`
`ports[].comment`	`string`
`ports[].repository`	`string`
`html`	`string (uri)`

`System`

Type: object

Property	Type	Description
`apiVersion` (required)	`integer`
`kind` (required)	`string`
`id` (required)	`string`
`label`	`string`
`count`	`integer`
`install`	array of `Install`
`derivativeOf`	`string \| null`
`sharedWithParent`	`integer \| null`
`html`	`string (uri)`

`SearchRequest`

Type: object

Property	Type	Description
`collection` (required)	`string`	One of `"ports"`.
`query` (required)	`string`
`limit`	`integer`	Default `10`. Maximum 100.
`algorithm`	`string`	One of `"bm25"`, `"bm25f"`, `"tfidf"`. Default `"bm25f"`.
`fuzzy`	`integer`	Minimum 0. Maximum 2.
`fieldWeights`	`object`
`filterMeta`	`object`	Any of the values within a key, all of the keys: system, repository, category, maintainer.
`facetBy`	`array of string`
`facetMaxValues`	`integer`
`facetScope`	`string`	One of `"all"`, `"page"`.
`highlight`	`boolean`
`maxHighlights`	`integer`
`fragmentSize`	`integer`

`SearchResponse`

Type: object

Property	Type	Description
`results`	`array of object`
`results[].score`	`number`
`results[].matchedTerms`	`array of string`
`results[].document`	`object`
`results[].document.key`	`string`
`results[].document.meta`	`object`	title (origin), name, version, comment, category, maintainer, repository, system, url (the page).
`results[].document.contentMd`	`string`
`total`	`integer`
`facets`	`object`

`AutocompleteResponse`

Type: object

Property	Type	Description
`items`	`array of object`
`items[].term`	`string`
`items[].field`	`string`
`items[].docCount`	`integer`
`total`	`integer`
`query`	`string`
`field`	`string`