slash/proto/gen/apidocs.swagger.md

api/v1/common.proto

Version: version not set

---

AuthService

/api/v1/auth/signin

POST

Parameters

Name	Located in	Description	Required	Schema
email	query		No	string
password	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1SignInResponse
default	An unexpected error response.	rpcStatus

/api/v1/auth/signout

POST

Responses

Code	Description	Schema
200	A successful response.	v1SignOutResponse
default	An unexpected error response.	rpcStatus

/api/v1/auth/signup

POST

Parameters

Name	Located in	Description	Required	Schema
email	query		No	string
nickname	query		No	string
password	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1SignUpResponse
default	An unexpected error response.	rpcStatus

/api/v1/auth/status

POST

Responses

Code	Description	Schema
200	A successful response.	v1GetAuthStatusResponse
default	An unexpected error response.	rpcStatus

---

CollectionService

/api/v1/collections

GET

Summary

ListCollections returns a list of collections.

Responses

Code	Description	Schema
200	A successful response.	v1ListCollectionsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

CreateCollection creates a collection.

Parameters

Name	Located in	Description	Required	Schema
collection	body		Yes	apiv1Collection

Responses

Code	Description	Schema
200	A successful response.	v1CreateCollectionResponse
default	An unexpected error response.	rpcStatus

/api/v1/collections/{collection.id}

PUT

Summary

UpdateCollection updates a collection.

Parameters

Name	Located in	Description	Required	Schema
collection.id	path		Yes	integer
collection	body		Yes	{ "creatorId": integer, "createdTime": dateTime, "updatedTime": dateTime, "name": string, "title": string, "description": string, "shortcutIds": [ integer ], "visibility": apiv1Visibility }
updateMask	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1UpdateCollectionResponse
default	An unexpected error response.	rpcStatus

/api/v1/collections/{id}

GET

Summary

GetCollection returns a collection by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1GetCollectionResponse
default	An unexpected error response.	rpcStatus

DELETE

Summary

DeleteCollection deletes a collection by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1DeleteCollectionResponse
default	An unexpected error response.	rpcStatus

---

ShortcutService

/api/v1/shortcuts

GET

Summary

ListShortcuts returns a list of shortcuts.

Responses

Code	Description	Schema
200	A successful response.	v1ListShortcutsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

CreateShortcut creates a shortcut.

Parameters

Name	Located in	Description	Required	Schema
shortcut	body		Yes	apiv1Shortcut

Responses

Code	Description	Schema
200	A successful response.	v1CreateShortcutResponse
default	An unexpected error response.	rpcStatus

/api/v1/shortcuts/{id}

GET

Summary

GetShortcut returns a shortcut by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1GetShortcutResponse
default	An unexpected error response.	rpcStatus

DELETE

Summary

DeleteShortcut deletes a shortcut by name.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1DeleteShortcutResponse
default	An unexpected error response.	rpcStatus

/api/v1/shortcuts/{id}/analytics

GET

Summary

GetShortcutAnalytics returns the analytics for a shortcut.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1GetShortcutAnalyticsResponse
default	An unexpected error response.	rpcStatus

/api/v1/shortcuts/{shortcut.id}

PUT

Summary

UpdateShortcut updates a shortcut.

Parameters

Name	Located in	Description	Required	Schema
shortcut.id	path		Yes	integer
shortcut	body		Yes	{ "creatorId": integer, "createdTime": dateTime, "updatedTime": dateTime, "rowStatus": apiv1RowStatus, "name": string, "link": string, "title": string, "tags": [ string ], "description": string, "visibility": apiv1Visibility, "viewCount": integer, "ogMetadata": apiv1OpenGraphMetadata }
updateMask	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1UpdateShortcutResponse
default	An unexpected error response.	rpcStatus

---

UserService

/api/v1/users

GET

Summary

ListUsers returns a list of users.

Responses

Code	Description	Schema
200	A successful response.	v1ListUsersResponse
default	An unexpected error response.	rpcStatus

POST

Summary

CreateUser creates a new user.

Parameters

Name	Located in	Description	Required	Schema
user	body		Yes	v1User

Responses

Code	Description	Schema
200	A successful response.	v1CreateUserResponse
default	An unexpected error response.	rpcStatus

/api/v1/users/{id}

GET

Summary

GetUser returns a user by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1GetUserResponse
default	An unexpected error response.	rpcStatus

DELETE

Summary

DeleteUser deletes a user by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1DeleteUserResponse
default	An unexpected error response.	rpcStatus

/api/v1/users/{id}/access_tokens

GET

Summary

ListUserAccessTokens returns a list of access tokens for a user.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the user id.	Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1ListUserAccessTokensResponse
default	An unexpected error response.	rpcStatus

POST

Summary

CreateUserAccessToken creates a new access token for a user.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the user id.	Yes	integer
body	body		Yes	UserServiceCreateUserAccessTokenBody

Responses

Code	Description	Schema
200	A successful response.	v1CreateUserAccessTokenResponse
default	An unexpected error response.	rpcStatus

/api/v1/users/{id}/access_tokens/{accessToken}

DELETE

Summary

DeleteUserAccessToken deletes an access token for a user.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the user id.	Yes	integer
accessToken	path	access_token is the access token to delete.	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1DeleteUserAccessTokenResponse
default	An unexpected error response.	rpcStatus

/api/v1/users/{user.id}

PATCH

Parameters

Name	Located in	Description	Required	Schema
user.id	path		Yes	integer
user	body		Yes	{ "rowStatus": apiv1RowStatus, "createdTime": dateTime, "updatedTime": dateTime, "role": v1Role, "email": string, "nickname": string, "password": string }

Responses

Code	Description	Schema
200	A successful response.	v1UpdateUserResponse
default	An unexpected error response.	rpcStatus

---

UserSettingService

/api/v1/users/{id}/settings

GET

Summary

GetUserSetting returns the user setting.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the user id.	Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v1GetUserSettingResponse
default	An unexpected error response.	rpcStatus

PATCH

Summary

UpdateUserSetting updates the user setting.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the user id.	Yes	integer
userSetting	body	user_setting is the user setting to update.	Yes	apiv1UserSetting

Responses

Code	Description	Schema
200	A successful response.	v1UpdateUserSettingResponse
default	An unexpected error response.	rpcStatus

---

WorkspaceService

/api/v1/workspace/profile

GET

Responses

Code	Description	Schema
200	A successful response.	v1GetWorkspaceProfileResponse
default	An unexpected error response.	rpcStatus

/api/v1/workspace/setting

GET

Responses

Code	Description	Schema
200	A successful response.	v1GetWorkspaceSettingResponse
default	An unexpected error response.	rpcStatus

PATCH

Parameters

Name	Located in	Description	Required	Schema
setting	body	The user setting.	Yes	apiv1WorkspaceSetting

Responses

Code	Description	Schema
200	A successful response.	v1UpdateWorkspaceSettingResponse
default	An unexpected error response.	rpcStatus

---

SubscriptionService

/v1/subscription

GET

Responses

Code	Description	Schema
200	A successful response.	v1GetSubscriptionResponse
default	An unexpected error response.	rpcStatus

PATCH

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1UpdateSubscriptionRequest

Responses

Code	Description	Schema
200	A successful response.	v1UpdateSubscriptionResponse
default	An unexpected error response.	rpcStatus

---

Models

GetShortcutAnalyticsResponseAnalyticsItem

Name	Type	Description	Required
name	string		No
count	integer		No

UserServiceCreateUserAccessTokenBody

Name	Type	Description	Required
description	string	description is the description of the access token.	No
expiresAt	dateTime	expires_at is the expiration time of the access token. If expires_at is not set, the access token will never expire.	No

UserSettingColorTheme

Name	Type	Description	Required
UserSettingColorTheme	string

UserSettingLocale

Name	Type	Description	Required
UserSettingLocale	string

apiv1AutoBackupWorkspaceSetting

Name	Type	Description	Required
enabled	boolean	Whether auto backup is enabled.	No
cronExpression	string	The cron expression for auto backup. For example, "0 0 0 ** *" means backup at 00:00:00 every day. See https://en.wikipedia.org/wiki/Cron for more details.	No
maxKeep	integer	The maximum number of backups to keep.	No

apiv1Collection

Name	Type	Description	Required
id	integer		No
creatorId	integer		No
createdTime	dateTime		No
updatedTime	dateTime		No
name	string		No
title	string		No
description	string		No
shortcutIds	[ integer ]		No
visibility	apiv1Visibility		No

apiv1OpenGraphMetadata

Name	Type	Description	Required
title	string		No
description	string		No
image	string		No

apiv1RowStatus

Name	Type	Description	Required
apiv1RowStatus	string

apiv1Shortcut

Name	Type	Description	Required
id	integer		No
creatorId	integer		No
createdTime	dateTime		No
updatedTime	dateTime		No
rowStatus	apiv1RowStatus		No
name	string		No
link	string		No
title	string		No
tags	[ string ]		No
description	string		No
visibility	apiv1Visibility		No
viewCount	integer		No
ogMetadata	apiv1OpenGraphMetadata		No

apiv1UserSetting

Name	Type	Description	Required
id	integer	id is the user id.	No
locale	UserSettingLocale	locale is the user locale.	No
colorTheme	UserSettingColorTheme	color_theme is the user color theme.	No

apiv1Visibility

Name	Type	Description	Required
apiv1Visibility	string

apiv1WorkspaceSetting

Name	Type	Description	Required
licenseKey	string		No
enableSignup	boolean	Whether to enable other users to sign up.	No
instanceUrl	string	The instance URL.	No
customStyle	string	The custom style.	No
customScript	string	The custom script.	No
autoBackup	apiv1AutoBackupWorkspaceSetting		No
defaultVisibility	apiv1Visibility	The default visibility of shortcuts and collections.	No

protobufAny

Name	Type	Description	Required
@type	string		No

rpcStatus

Name	Type	Description	Required
code	integer		No
message	string		No
details	[ protobufAny ]		No

v1CreateCollectionResponse

Name	Type	Description	Required
collection	apiv1Collection		No

v1CreateShortcutResponse

Name	Type	Description	Required
shortcut	apiv1Shortcut		No

v1CreateUserAccessTokenResponse

Name	Type	Description	Required
accessToken	v1UserAccessToken		No

v1CreateUserResponse

Name	Type	Description	Required
user	v1User		No

v1DeleteCollectionResponse

Name	Type	Description	Required
v1DeleteCollectionResponse	object

v1DeleteShortcutResponse

Name	Type	Description	Required
v1DeleteShortcutResponse	object

v1DeleteUserAccessTokenResponse

Name	Type	Description	Required
v1DeleteUserAccessTokenResponse	object

v1DeleteUserResponse

Name	Type	Description	Required
v1DeleteUserResponse	object

v1GetAuthStatusResponse

Name	Type	Description	Required
user	v1User		No

v1GetCollectionByNameResponse

Name	Type	Description	Required
collection	apiv1Collection		No

v1GetCollectionResponse

Name	Type	Description	Required
collection	apiv1Collection		No

v1GetShortcutAnalyticsResponse

Name	Type	Description	Required
references	[ GetShortcutAnalyticsResponseAnalyticsItem ]		No
devices	[ GetShortcutAnalyticsResponseAnalyticsItem ]		No
browsers	[ GetShortcutAnalyticsResponseAnalyticsItem ]		No

v1GetShortcutByNameResponse

Name	Type	Description	Required
shortcut	apiv1Shortcut		No

v1GetShortcutResponse

Name	Type	Description	Required
shortcut	apiv1Shortcut		No

v1GetSubscriptionResponse

Name	Type	Description	Required
subscription	v1Subscription		No

v1GetUserResponse

Name	Type	Description	Required
user	v1User		No

v1GetUserSettingResponse

Name	Type	Description	Required
userSetting	apiv1UserSetting		No

v1GetWorkspaceProfileResponse

Name	Type	Description	Required
profile	v1WorkspaceProfile	The workspace profile.	No

v1GetWorkspaceSettingResponse

Name	Type	Description	Required
setting	apiv1WorkspaceSetting	The user setting.	No

v1ListCollectionsResponse

Name	Type	Description	Required
collections	[ apiv1Collection ]		No

v1ListShortcutsResponse

Name	Type	Description	Required
shortcuts	[ apiv1Shortcut ]		No

v1ListUserAccessTokensResponse

Name	Type	Description	Required
accessTokens	[ v1UserAccessToken ]		No

v1ListUsersResponse

Name	Type	Description	Required
users	[ v1User ]		No

v1PlanType

Name	Type	Description	Required
v1PlanType	string

v1Role

Name	Type	Description	Required
v1Role	string

v1SignInResponse

Name	Type	Description	Required
user	v1User		No

v1SignOutResponse

Name	Type	Description	Required
v1SignOutResponse	object

v1SignUpResponse

Name	Type	Description	Required
user	v1User		No

v1Subscription

Name	Type	Description	Required
plan	v1PlanType		No
startedTime	dateTime		No
expiresTime	dateTime		No

v1UpdateCollectionResponse

Name	Type	Description	Required
collection	apiv1Collection		No

v1UpdateShortcutResponse

Name	Type	Description	Required
shortcut	apiv1Shortcut		No

v1UpdateSubscriptionRequest

Name	Type	Description	Required
licenseKey	string		Yes

v1UpdateSubscriptionResponse

Name	Type	Description	Required
subscription	v1Subscription		No

v1UpdateUserResponse

Name	Type	Description	Required
user	v1User		No

v1UpdateUserSettingResponse

Name	Type	Description	Required
userSetting	apiv1UserSetting		No

v1UpdateWorkspaceSettingResponse

Name	Type	Description	Required
setting	apiv1WorkspaceSetting	The user setting.	No

v1User

Name	Type	Description	Required
id	integer		No
rowStatus	apiv1RowStatus		No
createdTime	dateTime		No
updatedTime	dateTime		No
role	v1Role		No
email	string		No
nickname	string		No
password	string		No

v1UserAccessToken

Name	Type	Description	Required
accessToken	string		No
description	string		No
issuedAt	dateTime		No
expiresAt	dateTime		No

v1WorkspaceProfile

Name	Type	Description	Required
mode	string	Current workspace mode: dev, prod.	No
version	string	Current workspace version.	No
plan	v1PlanType	The workspace plan.	No
enableSignup	boolean	Whether to enable other users to sign up.	No
customStyle	string	The custom style.	No
customScript	string	The custom script.	No