Skip to content

Commit 81c27a6

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs:Chat API documentation update
PiperOrigin-RevId: 625051297
1 parent d0205ed commit 81c27a6

13 files changed

Lines changed: 225 additions & 234 deletions

‎google/chat/v1/action_status.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ option php_namespace = "Google\\Apps\\Chat\\V1";
2727
option ruby_package = "Google::Apps::Chat::V1";
2828

2929
// Represents the status for a request to either invoke or submit a
30-
// [dialog](https://developers.google.com/chat/how-tos/dialogs).
30+
// [dialog](https://developers.google.com/workspace/chat/dialogs).
3131
message ActionStatus {
3232
// The status code.
3333
google.rpc.Code status_code = 1;

‎google/chat/v1/annotation.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ option ruby_package = "Google::Apps::Chat::V1";
3030
// Output only. Annotations associated with the plain-text body of the message.
3131
// To add basic formatting to a text message, see
3232
// [Format text
33-
// messages](https://developers.google.com/chat/format-messages).
33+
// messages](https://developers.google.com/workspace/chat/format-messages).
3434
//
3535
// Example plain-text message body:
3636
// ```
@@ -155,7 +155,7 @@ message RichLinkMetadata {
155155
// Data for Google Drive links.
156156
message DriveLinkData {
157157
// A
158-
// [DriveDataRef](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref)
158+
// [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref)
159159
// which references a Google Drive file.
160160
DriveDataRef drive_data_ref = 1;
161161

‎google/chat/v1/attachment.proto‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,15 @@ message Attachment {
3434
pattern: "spaces/{space}/messages/{message}/attachments/{attachment}"
3535
};
3636

37+
// The source of the attachment.
3738
enum Source {
39+
// Reserved.
3840
SOURCE_UNSPECIFIED = 0;
3941

42+
// The file is a Google Drive file.
4043
DRIVE_FILE = 1;
4144

45+
// The file is uploaded to Chat.
4246
UPLOADED_CONTENT = 2;
4347
}
4448

@@ -52,6 +56,7 @@ message Attachment {
5256
// Output only. The content type (MIME type) of the file.
5357
string content_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
5458

59+
// The data reference to the attachment.
5560
oneof data_ref {
5661
// A reference to the attachment data. This field is used with the media API
5762
// to download the attachment data.
@@ -82,6 +87,7 @@ message DriveDataRef {
8287
string drive_file_id = 2;
8388
}
8489

90+
// A reference to the attachment data.
8591
message AttachmentDataRef {
8692
// The resource name of the attachment data. This field is used with the media
8793
// API to download the attachment data.
@@ -93,6 +99,7 @@ message AttachmentDataRef {
9399
string attachment_upload_token = 2;
94100
}
95101

102+
// Request to get an attachment.
96103
message GetAttachmentRequest {
97104
// Required. Resource name of the attachment, in the form
98105
// `spaces/*/messages/*/attachments/*`.
@@ -102,6 +109,7 @@ message GetAttachmentRequest {
102109
];
103110
}
104111

112+
// Request to upload an attachment.
105113
message UploadAttachmentRequest {
106114
// Required. Resource name of the Chat space in which the attachment is
107115
// uploaded. Format "spaces/{space}".
@@ -116,6 +124,7 @@ message UploadAttachmentRequest {
116124
string filename = 4 [(google.api.field_behavior) = REQUIRED];
117125
}
118126

127+
// Response of uploading an attachment.
119128
message UploadAttachmentResponse {
120129
// Reference to the uploaded attachment.
121130
AttachmentDataRef attachment_data_ref = 1;

‎google/chat/v1/chat_service.proto‎

Lines changed: 82 additions & 80 deletions
Large diffs are not rendered by default.

‎google/chat/v1/contextual_addon.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ message ContextualAddOnMarkup {
6666
// supported. For more information
6767
// about formatting text, see
6868
// [Formatting text in Google Chat
69-
// apps](https://developers.google.com/chat/format-messages#card-formatting)
69+
// apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
7070
// and
7171
// [Formatting
7272
// text in Google Workspace

‎google/chat/v1/membership.proto‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ message Membership {
9898
oneof memberType {
9999
// The Google Chat user or app the membership corresponds to.
100100
// If your Chat app [authenticates as a
101-
// user](https://developers.google.com/chat/api/guides/auth/users), the
102-
// output populates the
103-
// [user](https://developers.google.com/chat/api/reference/rest/v1/User)
101+
// user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
102+
// the output populates the
103+
// [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
104104
// `name` and `type`.
105105
User member = 3;
106106

@@ -127,6 +127,7 @@ message Membership {
127127
];
128128
}
129129

130+
// Request message for creating a membership.
130131
message CreateMembershipRequest {
131132
// Required. The resource name of the space for which to create the
132133
// membership.
@@ -158,6 +159,7 @@ message CreateMembershipRequest {
158159
Membership membership = 2 [(google.api.field_behavior) = REQUIRED];
159160
}
160161

162+
// Request message for listing memberships.
161163
message ListMembershipsRequest {
162164
// Required. The resource name of the space for which to fetch a membership
163165
// list.
@@ -175,8 +177,8 @@ message ListMembershipsRequest {
175177
//
176178
// If unspecified, at most 100 memberships are returned.
177179
//
178-
// The maximum value is 1,000. If you use a value more than 1,000, it's
179-
// automatically changed to 1,000.
180+
// The maximum value is 1000. If you use a value more than 1000, it's
181+
// automatically changed to 1000.
180182
//
181183
// Negative values return an `INVALID_ARGUMENT` error.
182184
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
@@ -192,9 +194,9 @@ message ListMembershipsRequest {
192194
// Optional. A query filter.
193195
//
194196
// You can filter memberships by a member's role
195-
// ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
197+
// ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
196198
// and type
197-
// ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
199+
// ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
198200
//
199201
// To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
200202
//
@@ -217,6 +219,7 @@ message ListMembershipsRequest {
217219
// role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
218220
// ```
219221
//
222+
//
220223
// Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
221224
// error.
222225
string filter = 5 [(google.api.field_behavior) = OPTIONAL];
@@ -237,10 +240,11 @@ message ListMembershipsRequest {
237240
// that don't match the filter criteria aren't returned.
238241
//
239242
// Currently requires [user
240-
// authentication](https://developers.google.com/chat/api/guides/auth/users).
243+
// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
241244
bool show_invited = 7 [(google.api.field_behavior) = OPTIONAL];
242245
}
243246

247+
// Response to list memberships of the space.
244248
message ListMembershipsResponse {
245249
// Unordered list. List of memberships in the requested (or first) page.
246250
repeated Membership memberships = 1
@@ -251,6 +255,7 @@ message ListMembershipsResponse {
251255
string next_page_token = 2;
252256
}
253257

258+
// Request to get a membership of a space.
254259
message GetMembershipRequest {
255260
// Required. Resource name of the membership to retrieve.
256261
//
@@ -260,8 +265,8 @@ message GetMembershipRequest {
260265
// Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
261266
//
262267
// When [authenticated as a
263-
// user](https://developers.google.com/chat/api/guides/auth/users), you can
264-
// use the user's email as an alias for `{member}`. For example,
268+
// user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
269+
// you can use the user's email as an alias for `{member}`. For example,
265270
// `spaces/{space}/members/[email protected]` where `[email protected]` is the
266271
// email of the Google Chat user.
267272
string name = 1 [
@@ -270,6 +275,7 @@ message GetMembershipRequest {
270275
];
271276
}
272277

278+
// Request to delete a membership in a space.
273279
message DeleteMembershipRequest {
274280
// Required. Resource name of the membership to delete. Chat apps can delete
275281
// human users' or their own memberships. Chat apps can't delete other apps'

0 commit comments

Comments
 (0)