GReg REST API

##Current state

Unstable

##Response Format All requests from the database are returned in JSON format with the following format:

{
    success: Boolean,
    timestamp: ms since the Unix epoch,
    contents: {
                ... If success, whatever it is you requested ...
              }
}

##GET

###User ####/toc/

This returns the terms of use acceptance status for the current authenticated user. If the user is not found, this API returns false for accepted field:

{
    user_id: String,
    accepted: Boolean
}

###Package ####/pkg/

This returns all of the package headers in the database.

####/pkgs/

This also returns all of the package headers in the database.

####/pkg/[id]

This returns the unique package header associated with that [id].

####/pkg_engine/[engine] Returns all the packages with the given engine name. (e.g. "dynamo" or "designscript")

####/pkg_engine/[engine]/[name]

Returns the single package with the given engine name ([engine]) and package name ([name]). This is guaranteed to be a single unique package.

###Package search

####/pkg_search/[query]

Returns the list of packages returned by keyword search ([query]) over the packages

####/pkg_search/[query] Returns the of packages returned by keyword search ([query]) over the packages

##POST

####/pkg/ Posts a new package. Requires an oauth authorization header validated from Oxygen.

##PUT

###User ####/toc/ Updates the terms of use acceptance status for the current authenticated user to true. If the call is successful, the following data is returned:

{
    user_id: String,
    accepted: Boolean
}

###Package ####/pkg/ Posts a new package version. Requires an oauth authorization header validated from Oxygen.

####/pkg-vote/[id] Votes for a package. Only increments if the user is authorized and never voted for the package before.

###Whitelist White-listing is used primarily in the context of Reach. When a package is white-listed, it will be downloaded and made available to Reach instances.

####/whitelist/:pkg_id Add a package to the white list.

####/unwhitelist/:pkg_id Remove a package from the white list.

####/whitelist Get all packages on the white list.

Starting and Stopping the Server

To start the server ./start-server
To stop the server ./stop-server

Log Files

The package manager ./start-server script uses foreverjs. It is configured to write three log files to /logs, ERR,OUT, and LOG. These log files are rotated weekly using logrotate. The logrotate configuration file, and a cron job for running logrotate can be found in /logrotate.

ikeough/GReg

GReg REST API

Starting and Stopping the Server

Log Files