Skip to content

Commit a4367c5

Browse files
Google APIscopybara-github
authored andcommitted
docs: Annotate all names with IDENTIFIER
docs: Use backticks around `username` in documentation for `Actor.email` PiperOrigin-RevId: 761132326
1 parent 7d43527 commit a4367c5

6 files changed

Lines changed: 16 additions & 10 deletions

File tree

google/cloud/support/v2/actor.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ message Actor {
4141
// email must also be provided. If the user is a Google Support agent, this is
4242
// obfuscated.
4343
//
44-
// This field is deprecated. Use **username** field instead.
44+
// This field is deprecated. Use `username` instead.
4545
string email = 2 [deprecated = true];
4646

4747
// Output only. Whether the actor is a Google support actor.

google/cloud/support/v2/attachment.proto

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ message Attachment {
4444
pattern: "projects/{project}/cases/{case}/attachments/{attachment_id}"
4545
};
4646

47-
// Output only. The resource name of the attachment.
48-
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
47+
// Output only. Identifier. The resource name of the attachment.
48+
string name = 1 [
49+
(google.api.field_behavior) = OUTPUT_ONLY,
50+
(google.api.field_behavior) = IDENTIFIER
51+
];
4952

5053
// Output only. The time at which the attachment was created.
5154
google.protobuf.Timestamp create_time = 2

google/cloud/support/v2/case.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ message Case {
108108
P4 = 5;
109109
}
110110

111-
// The resource name for the case.
112-
string name = 1;
111+
// Identifier. The resource name for the case.
112+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
113113

114114
// The short summary of the issue reported in this case.
115115
string display_name = 2;

google/cloud/support/v2beta/actor.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ message Actor {
4141
// email must also be provided. If the user is a Google Support agent, this is
4242
// obfuscated.
4343
//
44-
// This field is deprecated. Use **username** field instead.
44+
// This field is deprecated. Use `username` instead.
4545
string email = 2 [deprecated = true];
4646

4747
// Output only. Whether the actor is a Google support actor.

google/cloud/support/v2beta/attachment.proto

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ message Attachment {
4444
pattern: "projects/{project}/cases/{case}/attachments/{attachment_id}"
4545
};
4646

47-
// Output only. The resource name of the attachment.
48-
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
47+
// Output only. Identifier. The resource name of the attachment.
48+
string name = 1 [
49+
(google.api.field_behavior) = OUTPUT_ONLY,
50+
(google.api.field_behavior) = IDENTIFIER
51+
];
4952

5053
// Output only. The time at which the attachment was created.
5154
google.protobuf.Timestamp create_time = 2

google/cloud/support/v2beta/case.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ message Case {
120120
P4 = 5;
121121
}
122122

123-
// The resource name for the case.
124-
string name = 1;
123+
// Identifier. The resource name for the case.
124+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
125125

126126
// The short summary of the issue reported in this case.
127127
string display_name = 2;

0 commit comments

Comments
 (0)