Mirrors/juanfont.headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-11-10 01:20:58 +01:00
Code Issues Projects Releases Wiki Activity

update user api to use IDs over names

Browse Source 
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
This commit is contained in:
Kristoffer Dalby 2024-12-05 09:51:08 +01:00
parent 4967d87408
commit 273483a310
No known key found for this signature in database
2 changed files with 210 additions and 225 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

379
proto/headscale/v1/headscale.proto
View File

@ -1,6 +1,6 @@
syntax = "proto3";
package headscale.v1;
option go_package = "github.com/juanfont/headscale/gen/go/v1";
option go_package = "github.com/juanfont/headscale/gen/go/v1";
import "google/api/annotations.proto";
@ -13,225 +13,226 @@ import "headscale/v1/policy.proto";
// import "headscale/v1/device.proto";
service HeadscaleService {
// --- User start ---
rpc GetUser(GetUserRequest) returns (GetUserResponse) {
option (google.api.http) = {
get: "/api/v1/user/{name}"
};
}
// --- User start ---
rpc CreateUser(CreateUserRequest) returns (CreateUserResponse) {
option (google.api.http) = {
post : "/api/v1/user"
body : "*"
};
}
rpc CreateUser(CreateUserRequest) returns (CreateUserResponse) {
option (google.api.http) = {
post: "/api/v1/user"
body: "*"
};
}
rpc RenameUser(RenameUserRequest) returns (RenameUserResponse) {
option (google.api.http) = {
post : "/api/v1/user/{old_id}/rename/{new_name}"
};
}
rpc RenameUser(RenameUserRequest) returns (RenameUserResponse) {
option (google.api.http) = {
post: "/api/v1/user/{old_name}/rename/{new_name}"
};
}
rpc DeleteUser(DeleteUserRequest) returns (DeleteUserResponse) {
option (google.api.http) = {
delete : "/api/v1/user/{id}"
};
}
rpc DeleteUser(DeleteUserRequest) returns (DeleteUserResponse) {
option (google.api.http) = {
delete: "/api/v1/user/{name}"
};
}
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = {
get : "/api/v1/user"
};
}
// --- User end ---
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = {
get: "/api/v1/user"
};
}
// --- User end ---
// --- PreAuthKeys start ---
rpc CreatePreAuthKey(CreatePreAuthKeyRequest)
returns (CreatePreAuthKeyResponse) {
option (google.api.http) = {
post : "/api/v1/preauthkey"
body : "*"
};
}
// --- PreAuthKeys start ---
rpc CreatePreAuthKey(CreatePreAuthKeyRequest) returns (CreatePreAuthKeyResponse) {
option (google.api.http) = {
post: "/api/v1/preauthkey"
body: "*"
};
}
rpc ExpirePreAuthKey(ExpirePreAuthKeyRequest)
returns (ExpirePreAuthKeyResponse) {
option (google.api.http) = {
post : "/api/v1/preauthkey/expire"
body : "*"
};
}
rpc ExpirePreAuthKey(ExpirePreAuthKeyRequest) returns (ExpirePreAuthKeyResponse) {
option (google.api.http) = {
post: "/api/v1/preauthkey/expire"
body: "*"
};
}
rpc ListPreAuthKeys(ListPreAuthKeysRequest)
returns (ListPreAuthKeysResponse) {
option (google.api.http) = {
get : "/api/v1/preauthkey"
};
}
// --- PreAuthKeys end ---
rpc ListPreAuthKeys(ListPreAuthKeysRequest) returns (ListPreAuthKeysResponse) {
option (google.api.http) = {
get: "/api/v1/preauthkey"
};
}
// --- PreAuthKeys end ---
// --- Node start ---
rpc DebugCreateNode(DebugCreateNodeRequest)
returns (DebugCreateNodeResponse) {
option (google.api.http) = {
post : "/api/v1/debug/node"
body : "*"
};
}
// --- Node start ---
rpc DebugCreateNode(DebugCreateNodeRequest) returns (DebugCreateNodeResponse) {
option (google.api.http) = {
post: "/api/v1/debug/node"
body: "*"
};
}
rpc GetNode(GetNodeRequest) returns (GetNodeResponse) {
option (google.api.http) = {
get : "/api/v1/node/{node_id}"
};
}
rpc GetNode(GetNodeRequest) returns (GetNodeResponse) {
option (google.api.http) = {
get: "/api/v1/node/{node_id}"
};
}
rpc SetTags(SetTagsRequest) returns (SetTagsResponse) {
option (google.api.http) = {
post : "/api/v1/node/{node_id}/tags"
body : "*"
};
}
rpc SetTags(SetTagsRequest) returns (SetTagsResponse) {
option (google.api.http) = {
post: "/api/v1/node/{node_id}/tags"
body: "*"
};
}
rpc RegisterNode(RegisterNodeRequest) returns (RegisterNodeResponse) {
option (google.api.http) = {
post : "/api/v1/node/register"
};
}
rpc RegisterNode(RegisterNodeRequest) returns (RegisterNodeResponse) {
option (google.api.http) = {
post: "/api/v1/node/register"
};
}
rpc DeleteNode(DeleteNodeRequest) returns (DeleteNodeResponse) {
option (google.api.http) = {
delete : "/api/v1/node/{node_id}"
};
}
rpc DeleteNode(DeleteNodeRequest) returns (DeleteNodeResponse) {
option (google.api.http) = {
delete: "/api/v1/node/{node_id}"
};
}
rpc ExpireNode(ExpireNodeRequest) returns (ExpireNodeResponse) {
option (google.api.http) = {
post : "/api/v1/node/{node_id}/expire"
};
}
rpc ExpireNode(ExpireNodeRequest) returns (ExpireNodeResponse) {
option (google.api.http) = {
post: "/api/v1/node/{node_id}/expire"
};
}
rpc RenameNode(RenameNodeRequest) returns (RenameNodeResponse) {
option (google.api.http) = {
post : "/api/v1/node/{node_id}/rename/{new_name}"
};
}
rpc RenameNode(RenameNodeRequest) returns (RenameNodeResponse) {
option (google.api.http) = {
post: "/api/v1/node/{node_id}/rename/{new_name}"
};
}
rpc ListNodes(ListNodesRequest) returns (ListNodesResponse) {
option (google.api.http) = {
get : "/api/v1/node"
};
}
rpc ListNodes(ListNodesRequest) returns (ListNodesResponse) {
option (google.api.http) = {
get: "/api/v1/node"
};
}
rpc MoveNode(MoveNodeRequest) returns (MoveNodeResponse) {
option (google.api.http) = {
post : "/api/v1/node/{node_id}/user",
body : "*"
};
}
rpc MoveNode(MoveNodeRequest) returns (MoveNodeResponse) {
option (google.api.http) = {
post: "/api/v1/node/{node_id}/user",
body: "*"
};
}
rpc BackfillNodeIPs(BackfillNodeIPsRequest)
returns (BackfillNodeIPsResponse) {
option (google.api.http) = {
post : "/api/v1/node/backfillips"
};
}
rpc BackfillNodeIPs(BackfillNodeIPsRequest) returns (BackfillNodeIPsResponse) {
option (google.api.http) = {
post: "/api/v1/node/backfillips"
};
}
// --- Node end ---
// --- Node end ---
// --- Route start ---
rpc GetRoutes(GetRoutesRequest) returns (GetRoutesResponse) {
option (google.api.http) = {
get : "/api/v1/routes"
};
}
// --- Route start ---
rpc GetRoutes(GetRoutesRequest) returns (GetRoutesResponse) {
option (google.api.http) = {
get: "/api/v1/routes"
};
}
rpc EnableRoute(EnableRouteRequest) returns (EnableRouteResponse) {
option (google.api.http) = {
post : "/api/v1/routes/{route_id}/enable"
};
}
rpc EnableRoute(EnableRouteRequest) returns (EnableRouteResponse) {
option (google.api.http) = {
post: "/api/v1/routes/{route_id}/enable"
};
}
rpc DisableRoute(DisableRouteRequest) returns (DisableRouteResponse) {
option (google.api.http) = {
post : "/api/v1/routes/{route_id}/disable"
};
}
rpc DisableRoute(DisableRouteRequest) returns (DisableRouteResponse) {
option (google.api.http) = {
post: "/api/v1/routes/{route_id}/disable"
};
}
rpc GetNodeRoutes(GetNodeRoutesRequest) returns (GetNodeRoutesResponse) {
option (google.api.http) = {
get : "/api/v1/node/{node_id}/routes"
};
}
rpc GetNodeRoutes(GetNodeRoutesRequest) returns (GetNodeRoutesResponse) {
option (google.api.http) = {
get: "/api/v1/node/{node_id}/routes"
};
}
rpc DeleteRoute(DeleteRouteRequest) returns (DeleteRouteResponse) {
option (google.api.http) = {
delete : "/api/v1/routes/{route_id}"
};
}
rpc DeleteRoute(DeleteRouteRequest) returns (DeleteRouteResponse) {
option (google.api.http) = {
delete: "/api/v1/routes/{route_id}"
};
}
// --- Route end ---
// --- Route end ---
// --- ApiKeys start ---
rpc CreateApiKey(CreateApiKeyRequest) returns (CreateApiKeyResponse) {
option (google.api.http) = {
post : "/api/v1/apikey"
body : "*"
};
}
// --- ApiKeys start ---
rpc CreateApiKey(CreateApiKeyRequest) returns (CreateApiKeyResponse) {
option (google.api.http) = {
post: "/api/v1/apikey"
body: "*"
};
}
rpc ExpireApiKey(ExpireApiKeyRequest) returns (ExpireApiKeyResponse) {
option (google.api.http) = {
post : "/api/v1/apikey/expire"
body : "*"
};
}
rpc ExpireApiKey(ExpireApiKeyRequest) returns (ExpireApiKeyResponse) {
option (google.api.http) = {
post: "/api/v1/apikey/expire"
body: "*"
};
}
rpc ListApiKeys(ListApiKeysRequest) returns (ListApiKeysResponse) {
option (google.api.http) = {
get : "/api/v1/apikey"
};
}
rpc ListApiKeys(ListApiKeysRequest) returns (ListApiKeysResponse) {
option (google.api.http) = {
get: "/api/v1/apikey"
};
}
rpc DeleteApiKey(DeleteApiKeyRequest) returns (DeleteApiKeyResponse) {
option (google.api.http) = {
delete : "/api/v1/apikey/{prefix}"
};
}
// --- ApiKeys end ---
rpc DeleteApiKey(DeleteApiKeyRequest) returns (DeleteApiKeyResponse) {
option (google.api.http) = {
delete: "/api/v1/apikey/{prefix}"
};
}
// --- ApiKeys end ---
// --- Policy start ---
rpc GetPolicy(GetPolicyRequest) returns (GetPolicyResponse) {
option (google.api.http) = {
get : "/api/v1/policy"
};
}
// --- Policy start ---
rpc GetPolicy(GetPolicyRequest) returns (GetPolicyResponse) {
option (google.api.http) = {
get: "/api/v1/policy"
};
}
rpc SetPolicy(SetPolicyRequest) returns (SetPolicyResponse) {
option (google.api.http) = {
put : "/api/v1/policy"
body : "*"
};
}
// --- Policy end ---
rpc SetPolicy(SetPolicyRequest) returns (SetPolicyResponse) {
option (google.api.http) = {
put: "/api/v1/policy"
body: "*"
};
}
// --- Policy end ---
// Implement Tailscale API
// rpc GetDevice(GetDeviceRequest) returns(GetDeviceResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}"
// };
// }
// Implement Tailscale API
// rpc GetDevice(GetDeviceRequest) returns(GetDeviceResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}"
// };
// }
// rpc DeleteDevice(DeleteDeviceRequest) returns(DeleteDeviceResponse) {
// option(google.api.http) = {
// delete : "/api/v1/device/{id}"
// };
// }
// rpc DeleteDevice(DeleteDeviceRequest) returns(DeleteDeviceResponse) {
// option(google.api.http) = {
// delete : "/api/v1/device/{id}"
// };
// }
// rpc GetDeviceRoutes(GetDeviceRoutesRequest)
// returns(GetDeviceRoutesResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}/routes"
// };
// }
// rpc GetDeviceRoutes(GetDeviceRoutesRequest) returns(GetDeviceRoutesResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}/routes"
// };
// }
// rpc EnableDeviceRoutes(EnableDeviceRoutesRequest) returns(EnableDeviceRoutesResponse) {
// option(google.api.http) = {
// post : "/api/v1/device/{id}/routes"
// };
// }
// rpc EnableDeviceRoutes(EnableDeviceRoutesRequest)
// returns(EnableDeviceRoutesResponse) {
// option(google.api.http) = {
// post : "/api/v1/device/{id}/routes"
// };
// }
}

56
proto/headscale/v1/user.proto
View File

@ -1,55 +1,39 @@
syntax = "proto3";
package headscale.v1;
option go_package = "github.com/juanfont/headscale/gen/go/v1";
option go_package = "github.com/juanfont/headscale/gen/go/v1";
import "google/protobuf/timestamp.proto";
message User {
string id = 1;
string name = 2;
google.protobuf.Timestamp created_at = 3;
string display_name = 4;
string email = 5;
string provider_id = 6;
string provider = 7;
string profile_pic_url = 8;
uint64 id = 1;
string name = 2;
google.protobuf.Timestamp created_at = 3;
string display_name = 4;
string email = 5;
string provider_id = 6;
string provider = 7;
string profile_pic_url = 8;
}
message GetUserRequest {
string name = 1;
}
message CreateUserRequest { string name = 1; }
message GetUserResponse {
User user = 1;
}
message CreateUserRequest {
string name = 1;
}
message CreateUserResponse {
User user = 1;
}
message CreateUserResponse { User user = 1; }
message RenameUserRequest {
string old_name = 1;
string new_name = 2;
uint64 old_id = 1;
string new_name = 2;
}
message RenameUserResponse {
User user = 1;
}
message RenameUserResponse { User user = 1; }
message DeleteUserRequest {
string name = 1;
}
message DeleteUserRequest { uint64 id = 1; }
message DeleteUserResponse {
}
message DeleteUserResponse {}
message ListUsersRequest {
uint64 id = 1;
string name = 2;
string email = 3;
}
message ListUsersResponse {
repeated User users = 1;
}
message ListUsersResponse { repeated User users = 1; }