History

Ivan Fraixedes 9d7ef17a26 private/apigen: Fix code generation for slices & arrays Fix the API generator to generate valid TypeScript code when using slices an arrays of any type (base types, struct types, anonymous struct types, etc.). Closes https://github.com/storj/storj/issues/6323 Change-Id: I580ae5305c58f65c2e4f4a35d14ca4ee509a9250		2023-10-02 17:05:35 +02:00
..
main.go	private/apigen: Fix code generation for slices & arrays	2023-10-02 17:05:35 +02:00
README.md	satellite/.../consoleapi/gen: Update README	2023-08-23 19:49:35 +00:00

README.md

Generated Console REST API

The API defined in this package allows users to make requests related to their accounts, projects, and buckets, which would normally be performed within the Satellite UI.

This API is not enabled in all production environments, and it is not generally available to Storj customers.

Available Endpoints

Generated detailed documentation for each endpoint implemented can be found here.

Usage

Requires setting 'Authorization' header for requests. Users cannot currently generate their own REST API keys.

Example of request

curl  -i -L \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer <key>' \
    -X GET \
    "https://satellite.qa.storj.io/api/v0/projects/"

Successful responses

All the requests (except DELETE) have a non-empty response body for the resource that you're interacting with.

Example:

{
  "project": {
    "name": "My Awesome Project",
    "description": "it is perfect"
  }
}

Error responses

When an API endpoint returns an error (status code 4XX) it contains a JSON error response with 1 error field:

Example:

{
  "error": "authorization key format is incorrect. Should be 'Bearer <key>'"
}