totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-11 19:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Proto Update: Avatar, YouTube (#390)

Browse Source 
* Update avatar.proto

Shorten texts, correct mistakes, replace Micro with M3O, set colons

* Update youtube.proto

Remove example links, set colons
This commit is contained in:
Niko Diamadis
2022-02-28 17:11:44 +01:00
committed by GitHub
parent da87a90608
commit ee0746bac6
2 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
avatar/proto/avatar.proto
View File

@@ -10,22 +10,21 @@ service Avatar {
// Generate an unique avatar // Generate an unique avatar
message GenerateRequest { message GenerateRequest {
// avatar's gender, `male` or `female`, default is `male` // avatar's gender: `male` or `female`; default is `male`
string gender = 1; string gender = 1;
// avatar's username, unique username will generates the unique avatar; // avatar's username, unique username will generate the unique avatar;
// if username == "", will generate a random avatar in every request // if empty, every request generates a random avatar;
// if upload == true, username will be used as CDN filename rather than a random uuid string // if upload == true, username will be the CDN filename rather than a random uuid string
string username = 2; string username = 2;
// encode format of avatar image, `png` or `jpeg`, default is `jpeg` // encode format of avatar image: `png` or `jpeg`; default is `jpeg`
string format = 3; string format = 3;
// if upload to m3o CDN, default is `false` // set to true to upload to the M3O CDN and receive the url
// if update = true, then it'll return the CDN url
bool upload = 4; bool upload = 4;
} }
message GenerateResponse { message GenerateResponse {
// Micro's CDN url of the avatar image // M3O's CDN url of the avatar image
string url = 1; string url = 1;
// base64encode string of the avatar image // base64 encoded string of the avatar image
string base64 = 2; string base64 = 2;
} }

8
youtube/proto/youtube.proto
View File

@@ -11,7 +11,7 @@ service Youtube {
// Embed a YouTube video // Embed a YouTube video
message EmbedRequest { message EmbedRequest {
// provide the youtube url e.g https://www.youtube.com/watch?v=GWRWZu7XsJ0 // provide the youtube url
string url = 1; string url = 1;
} }
@@ -20,7 +20,7 @@ message EmbedResponse {
string long_url = 1; string long_url = 1;
// the short url // the short url
string short_url = 2; string short_url = 2;
// the embeddable link e.g https://www.youtube.com/watch?v=GWRWZu7XsJ0 // the embeddable link
string embed_url = 3; string embed_url = 3;
// the script code // the script code
string html_script = 4; string html_script = 4;
@@ -29,7 +29,7 @@ message EmbedResponse {
message SearchResult { message SearchResult {
// id of the result // id of the result
string id = 1; string id = 1;
// kind of result; "video", "channel", "playlist" // kind of result: "video", "channel", "playlist"
string kind = 2; string kind = 2;
// title of the result // title of the result
string title = 3; string title = 3;
@@ -41,7 +41,7 @@ message SearchResult {
string channel_title = 6; string channel_title = 6;
// published at time // published at time
string published_at = 7; string published_at = 7;
// if live broadcast then indicates activity. // if live broadcast then indicates activity:
// none, upcoming, live, completed // none, upcoming, live, completed
string broadcasting = 8; string broadcasting = 8;
// the associated url // the associated url