Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The APIs are simply a contract about the directory structure of the marketplace. All APIs are relative to a base path. For example, cask.co/marketplace/v1. The structure is expected to be:

Code Block
GET
<base>/categories.json
<base>/packages.json
<base>/packages-<category>.json
<base>/packages/<package-name>/versions.json
<base>/packages/<package-name>/<version>/icon.jpg
<base>/packages/<package-name>/<version>/spec.json
<base>/packages/<package-name>/<version>/spec.json.asc
<base>/packages/<package-name>/<version>/archive.zip
<base>/packages/<package-name>/<version>/archive.zip.asc
 
 

The packages.json, packages-<category>.json, and versions.json files will be generated using a tool from the categories.json and all the package spec.json files.

Note

In order to make serving easier, we are sacrificing flexibility and extensibility. For example, searching and filtering packages (beyond filtering by a single category) cannot be done in this way. One useful thing we may want to support very soon is filtering packages based on the CDAP version.

...