at.happyproto.registry.searchPackages

happyproto.at

Documentation

Find packages. Deleted packages are never returned. With `q` the result is ranked by match and capped rather than paged, because the index's substring search takes no cursor; without it the result is paged.

main query

Find packages. Deleted packages are never returned. With `q` the result is ranked by match and capped rather than paged, because the index's substring search takes no cursor; without it the result is paged.

Parameters

cursor string Optional

Ignored when `q` is given.

limit integer Optional

No description available.

pluginType string Optional

Only packages whose latest active release is this type.

q string Optional

Substring of the package name. Omit to list.

Output

Encodingapplication/json
cursor string Optional

Absent when `q` was given, or when the last page was reached.

packages array Required

No description available.

Errors

NotConfigured The registry instance has no identity configured (HAPPYPROTO_DID), so it cannot read its own state. An operator problem, not a caller's.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Ignored when `q` is given.
Only packages whose latest active release is this type.
Substring of the package name. Omit to list.
View raw schema 
{
  "description": "Find packages. Deleted packages are never returned. With `q` the result is ranked by match and capped rather than paged, because the index's substring search takes no cursor; without it the result is paged.",
  "errors": [
    {
      "description": "The registry instance has no identity configured (HAPPYPROTO_DID), so it cannot read its own state. An operator problem, not a caller's.",
      "name": "NotConfigured"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Absent when `q` was given, or when the last page was reached.",
          "type": "string"
        },
        "packages": {
          "items": {
            "ref": "at.happyproto.registry.defs#packageView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "packages"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "description": "Ignored when `q` is given.",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "pluginType": {
        "description": "Only packages whose latest active release is this type.",
        "knownValues": [
          "auth",
          "library",
          "interpreter"
        ],
        "type": "string"
      },
      "q": {
        "description": "Substring of the package name. Omit to list.",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@