Authentication¶

To access the API, user must be registered, have the developer role and generated an API key from the profile page. The Authorization header is mandatory and must contain the API key as user with no password. If the authentication fails, a 401 Unauthorized is returned.

Errors¶

In case of ambiguous error, a detailed explaination is returned in JSON as message

HTTP/1.1 422 UNPROCESSABLE ENTITY
Content-Length: 43
Content-Type: application/json

{
    "message": "Unknown architecture: myarch"
}

Endpoints¶

POST /api/packages¶

Post a SPK to the repository.

First a Package is created if not existing already, based on the name. Only users with package_admin role can create new packages, other users must be defined as maintainers to be able to continue.

Then a Version is created with its appropriate relationships if not existing already, based on the package and the version.

Lastly, a Build is created with its appropriate relationships and files saved on the filesystem.

Note

The created Build is not active by default

Example response:

HTTP/1.1 201 CREATED
Content-Length: 97

{
    "architectures": ["88f628x"],
    "firmware": "3.1-1594",
    "package": "btsync",
    "version": "1.4.103-10"
}

Status Codes:	201 Created – SPK registered 400 Bad Request – Request contained no body 403 Forbidden – Insufficient permission 409 Conflict – A Build already exists 422 Unprocessable Entity – Invalid or malformed SPK 500 Internal Server Error – Signing or filesystem issue

Referential¶

class spkrepo.models.Architecture(**kwargs)[source]¶

builds¶

code¶

classmethod find(code, syno=False)[source]¶

from_syno = {'88f6282': '88f628x', '88f6281': '88f628x'}¶

id¶

to_syno = {'88f628x': '88f6281'}¶

class spkrepo.models.Firmware(**kwargs)[source]¶

build¶

classmethod find(build)[source]¶

firmware_string¶

id¶

version¶

class spkrepo.models.Language(**kwargs)[source]¶

code¶

classmethod find(code)[source]¶

id¶

name¶

class spkrepo.models.Service(**kwargs)[source]¶

code¶

classmethod find(code)[source]¶

id¶

Users¶

class spkrepo.models.User(**kwargs)[source]¶

active¶

api_key¶

authored_packages¶

confirmed_at¶

email¶

github_access_token¶

id¶

maintained_packages¶

password¶

roles¶

username¶

class spkrepo.models.Role(**kwargs)[source]¶

description¶

classmethod find(name)[source]¶

id¶

name¶

users¶

Core¶

class spkrepo.models.Package(**kwargs)[source]¶

author¶

author_user_id¶

download_count¶

classmethod find(name)[source]¶

id¶

insert_date¶

maintainers¶

name¶

recent_download_count¶

screenshots¶

versions¶

class spkrepo.models.Version(**kwargs)[source]¶

all_builds_active = <sqlalchemy.sql.elements.BinaryExpression object>¶

beta = <sqlalchemy.sql.elements.BinaryExpression object>¶

builds¶

changelog¶

conf_conflicts¶

conf_dependencies¶

conflicts¶

dependencies¶

descriptions¶

displaynames¶

distributor¶

distributor_url¶

icons¶

id¶

insert_date¶

install_wizard¶

license¶

maintainer¶

maintainer_url¶

package¶

package_id¶

path¶

report_url¶

service_dependencies¶

startable¶

upgrade_wizard¶

upstream_version¶

version¶

version_string = <sqlalchemy.sql.elements.BinaryExpression object>¶

class spkrepo.models.Build(**kwargs)[source]¶

active¶

architectures¶

checksum¶

downloads¶

extract_size¶

firmware¶

firmware_id¶

classmethod generate_filename(package, version, firmware, architectures)[source]¶

id¶

insert_date¶

md5¶

path¶

publisher¶

publisher_user_id¶

save(stream)[source]¶

version¶

version_id¶

Data¶

class spkrepo.models.Screenshot(**kwargs)[source]¶

id¶

package¶

package_id¶

path¶

save(stream)[source]¶

class spkrepo.models.DisplayName(**kwargs)[source]¶

displayname¶

language¶

language_id¶

version_id¶

class spkrepo.models.Description(**kwargs)[source]¶

description¶

language¶

language_id¶

version_id¶

class spkrepo.models.Icon(**kwargs)[source]¶

id¶

path¶

save(stream)[source]¶

size¶

version¶

version_id¶

Statistics¶

class spkrepo.models.Download(**kwargs)[source]¶

architecture¶

architecture_id¶

build¶

build_id¶

date¶

firmware_build¶

id¶

ip_address¶

user_agent¶