media-service

README

Media Service API

The Media service API handles all the media'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 /media	N/A	Media* list
Get	GET /media/{media-id}	N/A	Media*
Create	POST /private/media	Media	Media*
Update	PUT or PATCH /private/media/{media-id}	Media	Media*
Delete	DELETE /private/media/{media-id}	N/A	protobuf.empty/{}
Restore/Active	PATCH /private/media/{media-id}	N/A	protobuf.empty/{}
HardDelete	DELETE /admin/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

Extra fields:

• lang = string (ISO 639-1 language code)
• media_type = string (book, video, podcast or doc)
• publisher = string
• author = string

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

• Main maintainer: maestre3d