Skip to content

protocol.md

Latest commit

 

History

History
140 lines (107 loc) · 1.58 KB

protocol.md

File metadata and controls

140 lines (107 loc) · 1.58 KB

Wool Registry Protocol

Version 0

registry

HTTP Request

GET /packages

namespace

Provides information on the requested namespace.

HTTP Request

GET /packages/[namespace]

Example

Request

/packages/lsjroberts

Response

{
  "name": "lsjroberts",
  "packages": [
    "lsjroberts/example"
  ]
}

package

Provides information on the requested package.

HTTP Request

GET /packages/[namespace]/[package]

Examples

Latest version

Request
/packages/lsjroberts/example
Response
{
  "name": "lsjroberts/example",
  "version": "1.0.0",
  "dependencies": {
    "bob/package": {
      "version": "1.0.0 <= v < 2.0.0"
    }
  },
  "versions": [
    "0.1.0",
    "0.2.0",
    "1.0.0"
  ],
  "publishedDate" {
    "0.1.0": "...",
    "0.2.0": "...",
    "1.0.0": "..."
  }
}

Specific version

Request
/packages/lsjroberts/example/0.2.0
Response
{
  "name": "lsjroberts/example",
  "version": "0.2.0",
  "dependencies": {},
  "versions": [
    "0.1.0",
    "0.2.0",
    "1.0.0"
  ],
  "publishedDate" {
    "0.1.0": "...",
    "0.2.0": "...",
    "1.0.0": "..."
  }
}

Latest in version range

Request
/packages/lsjroberts/example?range=1.0.0%20%3C%3D%20v%20%3C%202.0.0
Response
{
  "name": "lsjroberts/example",
  "version": "1.0.0",
  "dependencies": {},
  "versions": [
    "0.1.0",
    "0.2.0",
    "1.0.0"
  ],
  "publishedDate" {
    "0.1.0": "...",
    "0.2.0": "...",
    "1.0.0": "..."
  }
}