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

Package route

Jump to bottom
Fingercomp edited this page Nov 23, 2016 · 5 revisions

Retrieve a package

Send a GET request to /package/:name.

Responses

Status Comment
200 OK
404 Not Found
Request Response 
GET /packages/abc HTTP/1.1
...

HTTP/1.1 200 OK
...

{"success": true,
"code": 200,
"data": {
"name": "abc",
"description": "...",
...
}
}

GET /package/no-such-package HTTP/1.1
...

HTTP/1.1 404 Not Found
...

{"success": false,
"code": 400,
...
}

Delete a package

Requires authorization. Has an ACE.

Send a DELETE request to /packages/:name.

Responses

Status Comment
204 No Content Deleted successfully.
404 Not Found
Request Response 
DELETE /packages/package HTTP/1.1
Cookie: ...
...

HTTP/1.1 204 No Content
...

DELETE /packages/no-such-package HTTP/1.1
Cookie: ...
...

HTTP/1.1 404 Not Found
...

Update a package

Requires authorization. Has an ACE

Send a PATCH request to /packages/:name. The body should contain the parts of package to update. See the package model for details.

Set the value to null to remove a version, file, dependency, or screenshot.

Sending unexisting version, file, dependency, or screenshot keys is treated as creating a new version, file, dependency, or screenshot, respectively. Note that when creating a new version, you must provide all version fields (depends, files, changes).

Responses

Status Comment
204 No Content Package successfully updated.
400 Bad Request The data is malformed. See message for more details on the error.
404 Not Found
Request Response 
PATCH /package/package HTTP/1.1
Cookie: ...
...

{"name": "new-package",
"version": {
"1.12.0": {
"files": {...},
"depends": {...},
"changes": "...",
},
"1.0.0": {
"files": {
"...": {
"dir": "/new/path"
},
"...": null
},
"depends": {
"...": null
}
},
"1.11.5": null
},
"screenshots": {
"http://example.com/new-image.png": "...",
"http://example.com/old-image.png": null
}
}

HTTP/1.1 204 No Content
...

PATCH /packages/package HTTP/1.1
Cookie: ...

{"name": "."}

HTTP/1.1 400 Bad Request
...

{"success": false,
"code": 400,
...
}

PATCH /packages/no-such-package HTTP/1.1
Cookie: ...
...

{}

HTTP/1.1 404 Not Found
...

Changes

Version Changes
3.1.0 PATCH and DELETE now check for JSON validity and package existence.
3.0.3 Refactored the code of package update route a bit.

See Also

Clone this wiki locally