blob-service

module
v0.0.0-...-833cb33 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2020 License: AGPL-3.0

README

Blob Service API

The Blob service API handles all the blob's domain operations.

It contains multi-layered APIs such as Public, Private and Admin API.

It uses gRPC and HTTP communication protocols to expose its APIs.

Alexandria is currently licensed under the MIT license.

Endpoints

Method HTTP Mapping HTTP Request body HTTP Response body
List GET /admin/blob N/A Blob* List
Identity/User
Method HTTP Mapping HTTP Request body HTTP Response body
Get GET /blob/user/{user-id} N/A Blob*
Store POST /private/blob/user/{user-id} File Blob*
Delete DELETE /private/blob/user/{user-id} N/A protobuf.empty/{}
Author
Method HTTP Mapping HTTP Request body HTTP Response body
Get GET /blob/author/{author-id} N/A Blob*
Store POST /private/blob/author/{author-id} File Blob*
Delete DELETE /private/blob/author/{author-id} N/A protobuf.empty/{}
Media
Method HTTP Mapping HTTP Request body HTTP Response body
Get GET /blob/media/{media-id} N/A Blob*
Store POST /private/blob/media/{media-id} File Blob*
Delete DELETE /private/blob/media/{media-id} N/A protobuf.empty/{}
Accepted Queries

The list method accepts multiple queries to make data fetching easier for everyone.

The following fields are valid for our service.

  • page_token = string
  • page_size = int32 (min. 1, max. 100)
  • query = string
  • filter_by = string (id, timestamp or popularity by default)
  • sort = string (asc or desc)
  • show_disabled = boolean

Contribution

Alexandria is an open-source project, that means everyone’s help is appreciated.

If you'd like to contribute, please look at the Go Contribution Guidelines.

Click here if you're looking for our docs about engineering, Alexandria API, etc.

Maintenance

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL