Package model

{
  "name": "my-app",
  "description": "My application",
  "short_description": "My application",
  "owners": ["user1", "snake"],
  "authors": [
    "Some. O <[email protected]>",
    "Another. O (Yes) <[email protected]>"
  ],
  "license": "GPL-3",
  "tags": ["aaa", "bbb", "xxx"],
  "versions": {
    "0.0.1": {
      "files": {
         "http://example.com/file1": {
           "path": "/lib/filename1"
         },
         "http://example.com/file2": {
           "path": "/bin/filename2"
         },
         "http://example.com/file3": {
           "path": "/lib/super-program-data/filename3"
        }
      },
      "depends": {
         "some-package": {
           "version": "*",
           "type": "required"
         },
         "some-package-docs": {
           "version": "1.0",
           "type": "optional"
        }
      },
      "changes": "Changes..."
    }
  },
  "screenshots": {
    "http://example.com/img1.png": "description",
    "http://example.com/img2.png": "description",
    "http://example.com/img3.png": "description"
  },
  "stats": {
    "views": 0,
    "date": {
      "created": "2016-10-01 12:34:56",
      "last-update": "2016-10-05 16:23:30"
    }
  }
}

Model	Description
{"name": "",	The name of package. May only contain alphanumerical characters, and dash.
"description": "",	The full description of the package, formatted as a Markdown document.
"short_description": "",	The short description of the package, as plain-text. It must be no more than 140 characters.
"owners": [ "username", "username" ],	The owners of the package. They can edit and delete the package.
"authors": [ "Name ", "Name " ],	The program authors.
"license": "Apache 2.0",	The program license.
"tags": [ "tag 1", "tag 2" ],	The list of package tags.
"versions": {	The package versions.
"1.0.0": {	A version of the package. The Semantic Versioning must be used.
"files": {	The list of version files.
"http://example.com/file-1": {	The URL to file.
"dir": "/usr/bin",	The directory where the file will be downloaded. Deprecated, will be removed in [email protected]. Use path instead.
"name": "file.lua",	The name of the file. Must not end in slash. Deprecated, will be removed in [email protected]. Use path instead.
"path": "/dir/file.lua" } },	The path to file from the root directory. Must not end in slash.
"depends": {	The list of program dependencies.
"dep-package": {	The name of the dependency package.
"type": "recommended",	The type of the dependency. Either recommended, optional, or required.
"version": "~2.0" } }	Version constraint.
"changes": "" },	The changelog, formatted as a Markdown document.
"screenshots": {	The list of screenshots (or package-related images in general)
"http://example.com/img.png": "" },	The URL to image. : The description of the image.
"stats": {	The package statistics.
"views": 10,	How many times the package has been accessed.
"date": { "created": "2016-01-01 12:34:56",	When the package has been created (UTC).
"last-update": "2016-06-01 12:34:56" } } }	The last time the package has been updated (UTC).

Changes

Version	Changes
3.3.0	Deprecated dir and name, added path.
3.0.0	Removed stats.downloads.

See Also

• /packages route
• /packages/:name route