This endpoint responds with the search result. Special search qualifiers can be provided in the full-text query: - author:bcoe: Show/filter results in which bcoe is the author - maintainer:bcoe: Show/filter results in which bcoe is qualifier as a maintainer - keywords:batman: Show/filter results that have batman in the keywords - separating multiple keywords with - , acts like a logical OR - + acts like a logical AND - ,- can be used to exclude keywords - not:unstable: Exclude packages whose version is < 1.0.0 - not:insecure: Exclude packages that are insecure or have vulnerable dependencies (based on the nsp registry) - is:unstable: Show/filter packages whose version is < 1.0.0 - is:insecure: Show/filter packages that are insecure or have vulnerable dependencies (based on the nsp registry) - boost-exact:false: Do not boost exact matches, defaults to true Note: the values of quality, popularity, and maintenance are normalized into a unit-vector provide values between 0 - 1 for each to modify weightings, e.g., to return results based solely on quality, set quality=1.0, maintenance=0.0, popularity=0.0.
This endpoint responds with the package metadata document, sometimes informally called a “packument” or “doc.json”.Parameters:
Parameter
Type
Required
Default
Description
packageName
string
Yes
—
The name of the package
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "packageName": { "type": "string", "description": "The name of the package" } }, "required": [ "PCID", "packageName" ]}
This endpoint responds with the package metadata document for a specific version.Parameters:
Parameter
Type
Required
Default
Description
packageName
string
Yes
—
The name of the package
packageVersion
string
Yes
—
a version number or “latest”
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "packageName": { "type": "string", "description": "The name of the package" }, "packageVersion": { "type": "string", "description": "a version number or \"latest\"" } }, "required": [ "PCID", "packageName", "packageVersion" ]}
This endpoint responds with the search result. Special search qualifiers can be provided in the full-text query: - author:bcoe: Show/filter results in which bcoe is the author - maintainer:bcoe: Show/filter results in which bcoe is qualifier as a maintainer - keywords:batman: Show/filter results that have batman in the keywords - separating multiple keywords with - , acts like a logical OR - + acts like a logical AND - ,- can be used to exclude keywords - not:unstable: Exclude packages whose version is < 1.0.0 - not:insecure: Exclude packages that are insecure or have vulnerable dependencies (based on the nsp registry) - is:unstable: Show/filter packages whose version is < 1.0.0 - is:insecure: Show/filter packages that are insecure or have vulnerable dependencies (based on the nsp registry) - boost-exact:false: Do not boost exact matches, defaults to true Note: the values of quality, popularity, and maintenance are normalized into a unit-vector provide values between 0 - 1 for each to modify weightings, e.g., to return results based solely on quality, set quality=1.0, maintenance=0.0, popularity=0.0.Parameters:
Parameter
Type
Required
Default
Description
text
string
No
—
Full-text search to apply
size
integer
No
—
How many results should be returned (default 20, max 250)
from
integer
No
—
Offset to return results from
quality
number
No
—
How much of an effect should quality have on search results
popularity
number
No
—
How much of an effect should popularity have on search results
maintenance
number
No
—
How much of an effect should maintenance have on search results
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "text": { "type": "string", "description": "Full-text search to apply" }, "size": { "type": "integer", "description": "How many results should be returned (default 20, max 250)" }, "from": { "type": "integer", "description": "Offset to return results from" }, "quality": { "type": "number", "description": "How much of an effect should quality have on search results" }, "popularity": { "type": "number", "description": "How much of an effect should popularity have on search results" }, "maintenance": { "type": "number", "description": "How much of an effect should maintenance have on search results" } }, "required": [ "PCID" ]}