Skip to content

Commit

Permalink
docs: update comments on protos (#151)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Mar 1, 2019
1 parent d113a0a commit 6f039ca
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.common";
option php_namespace = "Google\\Cloud\\OsLogin\\Common";


// The POSIX account information associated with a Google account.
message PosixAccount {
// Only one POSIX account can be marked as primary.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,44 +28,62 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.v1beta";
option php_namespace = "Google\\Cloud\\OsLogin\\V1beta";


// Cloud OS Login API
//
// The Cloud OS Login API allows you to manage users and their associated SSH
// public keys for logging into virtual machines on Google Cloud Platform.
service OsLoginService {
// Deletes a POSIX account.
rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1beta/{name=users/*/projects/*}" };
rpc DeletePosixAccount(DeletePosixAccountRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=users/*/projects/*}"
};
}

// Deletes an SSH public key.
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1beta/{name=users/*/sshPublicKeys/*}" };
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=users/*/sshPublicKeys/*}"
};
}

// Retrieves the profile information used for logging in to a virtual machine
// on Google Compute Engine.
rpc GetLoginProfile(GetLoginProfileRequest) returns (LoginProfile) {
option (google.api.http) = { get: "/v1beta/{name=users/*}/loginProfile" };
option (google.api.http) = {
get: "/v1beta/{name=users/*}/loginProfile"
};
}

// Retrieves an SSH public key.
rpc GetSshPublicKey(GetSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { get: "/v1beta/{name=users/*/sshPublicKeys/*}" };
rpc GetSshPublicKey(GetSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
get: "/v1beta/{name=users/*/sshPublicKeys/*}"
};
}

// Adds an SSH public key and returns the profile information. Default POSIX
// account information is set when no username and UID exist as part of the
// login profile.
rpc ImportSshPublicKey(ImportSshPublicKeyRequest) returns (ImportSshPublicKeyResponse) {
option (google.api.http) = { post: "/v1beta/{parent=users/*}:importSshPublicKey" body: "ssh_public_key" };
rpc ImportSshPublicKey(ImportSshPublicKeyRequest)
returns (ImportSshPublicKeyResponse) {
option (google.api.http) = {
post: "/v1beta/{parent=users/*}:importSshPublicKey"
body: "ssh_public_key"
};
}

// Updates an SSH public key and returns the profile information. This method
// supports patch semantics.
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { patch: "/v1beta/{name=users/*/sshPublicKeys/*}" body: "ssh_public_key" };
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
patch: "/v1beta/{name=users/*/sshPublicKeys/*}"
body: "ssh_public_key"
};
}
}

Expand Down
12 changes: 6 additions & 6 deletions packages/google-cloud-oslogin/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"updateTime": "2019-02-13T12:20:30.549192Z",
"updateTime": "2019-03-01T12:17:20.662580Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.13",
"dockerImage": "googleapis/artman@sha256:5fd9aee1d82a00cebf425c8fa431f5457539562f5867ad9c54370f0ec9a7ccaa"
"version": "0.16.14",
"dockerImage": "googleapis/artman@sha256:f3d61ae45abaeefb6be5f228cda22732c2f1b00fb687c79c4bd4f2c42bb1e1a7"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "ca61898878f0926dd9dcc68ba90764f17133efe4",
"internalRef": "233680013"
"sha": "41d72d444fbe445f4da89e13be02078734fb7875",
"internalRef": "236230004"
}
},
{
"template": {
"name": "node_library",
"origin": "synthtool.gcp",
"version": "2019.1.16"
"version": "2019.2.26"
}
}
],
Expand Down

0 comments on commit 6f039ca

Please sign in to comment.