Skip to content

Commit 3ef440a

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Update Cloud Support RPC comments to no longer include cURL and Python examples
PiperOrigin-RevId: 760759691
1 parent 1a22026 commit 3ef440a

3 files changed

Lines changed: 0 additions & 372 deletions

File tree

‎google/cloud/support/v2/attachment_service.proto‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -37,36 +37,6 @@ service CaseAttachmentService {
3737
"https://www.googleapis.com/auth/cloud-platform";
3838

3939
// List all the attachments associated with a support case.
40-
//
41-
// EXAMPLES:
42-
//
43-
// cURL:
44-
//
45-
// ```shell
46-
// case="projects/some-project/cases/23598314"
47-
// curl \
48-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
49-
// "https://cloudsupport.googleapis.com/v2/$case/attachments"
50-
// ```
51-
//
52-
// Python:
53-
//
54-
// ```python
55-
// import googleapiclient.discovery
56-
//
57-
// api_version = "v2"
58-
// supportApiService = googleapiclient.discovery.build(
59-
// serviceName="cloudsupport",
60-
// version=api_version,
61-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
62-
// )
63-
// request = (
64-
// supportApiService.cases()
65-
// .attachments()
66-
// .list(parent="projects/some-project/cases/43595344")
67-
// )
68-
// print(request.execute())
69-
// ```
7040
rpc ListAttachments(ListAttachmentsRequest)
7141
returns (ListAttachmentsResponse) {
7242
option (google.api.http) = {

‎google/cloud/support/v2/case_service.proto‎

Lines changed: 0 additions & 274 deletions
Original file line numberDiff line numberDiff line change
@@ -39,35 +39,6 @@ service CaseService {
3939
"https://www.googleapis.com/auth/cloud-platform";
4040

4141
// Retrieve a case.
42-
//
43-
// EXAMPLES:
44-
//
45-
// cURL:
46-
//
47-
// ```shell
48-
// case="projects/some-project/cases/16033687"
49-
// curl \
50-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
51-
// "https://cloudsupport.googleapis.com/v2/$case"
52-
// ```
53-
//
54-
// Python:
55-
//
56-
// ```python
57-
// import googleapiclient.discovery
58-
//
59-
// api_version = "v2"
60-
// supportApiService = googleapiclient.discovery.build(
61-
// serviceName="cloudsupport",
62-
// version=api_version,
63-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
64-
// )
65-
//
66-
// request = supportApiService.cases().get(
67-
// name="projects/some-project/cases/43595344",
68-
// )
69-
// print(request.execute())
70-
// ```
7142
rpc GetCase(GetCaseRequest) returns (Case) {
7243
option (google.api.http) = {
7344
get: "/v2/{name=projects/*/cases/*}"
@@ -81,34 +52,6 @@ service CaseService {
8152
// For example, listing cases under an organization only returns the cases
8253
// that are directly parented by that organization. To retrieve cases
8354
// under an organization and its projects, use `cases.search`.
84-
//
85-
// EXAMPLES:
86-
//
87-
// cURL:
88-
//
89-
// ```shell
90-
// parent="projects/some-project"
91-
// curl \
92-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
93-
// "https://cloudsupport.googleapis.com/v2/$parent/cases"
94-
// ```
95-
//
96-
// Python:
97-
//
98-
// ```python
99-
// import googleapiclient.discovery
100-
//
101-
// api_version = "v2"
102-
// supportApiService = googleapiclient.discovery.build(
103-
// serviceName="cloudsupport",
104-
// version=api_version,
105-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
106-
// )
107-
//
108-
// request =
109-
// supportApiService.cases().list(parent="projects/some-project")
110-
// print(request.execute())
111-
// ```
11255
rpc ListCases(ListCasesRequest) returns (ListCasesResponse) {
11356
option (google.api.http) = {
11457
get: "/v2/{parent=projects/*}/cases"
@@ -118,34 +61,6 @@ service CaseService {
11861
}
11962

12063
// Search for cases using a query.
121-
//
122-
// EXAMPLES:
123-
//
124-
// cURL:
125-
//
126-
// ```shell
127-
// parent="projects/some-project"
128-
// curl \
129-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
130-
// "https://cloudsupport.googleapis.com/v2/$parent/cases:search"
131-
// ```
132-
//
133-
// Python:
134-
//
135-
// ```python
136-
// import googleapiclient.discovery
137-
//
138-
// api_version = "v2"
139-
// supportApiService = googleapiclient.discovery.build(
140-
// serviceName="cloudsupport",
141-
// version=api_version,
142-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
143-
// )
144-
// request = supportApiService.cases().search(
145-
// parent="projects/some-project", query="state=OPEN"
146-
// )
147-
// print(request.execute())
148-
// ```
14964
rpc SearchCases(SearchCasesRequest) returns (SearchCasesResponse) {
15065
option (google.api.http) = {
15166
get: "/v2/{parent=projects/*}/cases:search"
@@ -158,61 +73,6 @@ service CaseService {
15873
// It must have the following fields set: `display_name`, `description`,
15974
// `classification`, and `priority`. If you're just testing the API and don't
16075
// want to route your case to an agent, set `testCase=true`.
161-
//
162-
// EXAMPLES:
163-
//
164-
// cURL:
165-
//
166-
// ```shell
167-
// parent="projects/some-project"
168-
// curl \
169-
// --request POST \
170-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
171-
// --header 'Content-Type: application/json' \
172-
// --data '{
173-
// "display_name": "Test case created by me.",
174-
// "description": "a random test case, feel free to close",
175-
// "classification": {
176-
// "id":
177-
// "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
178-
// },
179-
// "time_zone": "-07:00",
180-
// "subscriber_email_addresses": [
181-
// "[email protected]",
182-
// "[email protected]"
183-
// ],
184-
// "testCase": true,
185-
// "priority": "P3"
186-
// }' \
187-
// "https://cloudsupport.googleapis.com/v2/$parent/cases"
188-
// ```
189-
//
190-
// Python:
191-
//
192-
// ```python
193-
// import googleapiclient.discovery
194-
//
195-
// api_version = "v2"
196-
// supportApiService = googleapiclient.discovery.build(
197-
// serviceName="cloudsupport",
198-
// version=api_version,
199-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
200-
// )
201-
// request = supportApiService.cases().create(
202-
// parent="projects/some-project",
203-
// body={
204-
// "displayName": "A Test Case",
205-
// "description": "This is a test case.",
206-
// "testCase": True,
207-
// "priority": "P2",
208-
// "classification": {
209-
// "id":
210-
// "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
211-
// },
212-
// },
213-
// )
214-
// print(request.execute())
215-
// ```
21676
rpc CreateCase(CreateCaseRequest) returns (Case) {
21777
option (google.api.http) = {
21878
post: "/v2/{parent=projects/*}/cases"
@@ -226,43 +86,6 @@ service CaseService {
22686
}
22787

22888
// Update a case. Only some fields can be updated.
229-
//
230-
// EXAMPLES:
231-
//
232-
// cURL:
233-
//
234-
// ```shell
235-
// case="projects/some-project/cases/43595344"
236-
// curl \
237-
// --request PATCH \
238-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
239-
// --header "Content-Type: application/json" \
240-
// --data '{
241-
// "priority": "P1"
242-
// }' \
243-
// "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
244-
// ```
245-
//
246-
// Python:
247-
//
248-
// ```python
249-
// import googleapiclient.discovery
250-
//
251-
// api_version = "v2"
252-
// supportApiService = googleapiclient.discovery.build(
253-
// serviceName="cloudsupport",
254-
// version=api_version,
255-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
256-
// )
257-
// request = supportApiService.cases().patch(
258-
// name="projects/some-project/cases/43112854",
259-
// body={
260-
// "displayName": "This is Now a New Title",
261-
// "priority": "P2",
262-
// },
263-
// )
264-
// print(request.execute())
265-
// ```
26689
rpc UpdateCase(UpdateCaseRequest) returns (Case) {
26790
option (google.api.http) = {
26891
patch: "/v2/{case.name=projects/*/cases/*}"
@@ -282,48 +105,6 @@ service CaseService {
282105
// https://cloud.google.com/support and look for 'Technical support
283106
// escalations' in the feature list to find out which ones let you
284107
// do that.
285-
//
286-
// EXAMPLES:
287-
//
288-
// cURL:
289-
//
290-
// ```shell
291-
// case="projects/some-project/cases/43595344"
292-
// curl \
293-
// --request POST \
294-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
295-
// --header "Content-Type: application/json" \
296-
// --data '{
297-
// "escalation": {
298-
// "reason": "BUSINESS_IMPACT",
299-
// "justification": "This is a test escalation."
300-
// }
301-
// }' \
302-
// "https://cloudsupport.googleapis.com/v2/$case:escalate"
303-
// ```
304-
//
305-
// Python:
306-
//
307-
// ```python
308-
// import googleapiclient.discovery
309-
//
310-
// api_version = "v2"
311-
// supportApiService = googleapiclient.discovery.build(
312-
// serviceName="cloudsupport",
313-
// version=api_version,
314-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
315-
// )
316-
// request = supportApiService.cases().escalate(
317-
// name="projects/some-project/cases/43595344",
318-
// body={
319-
// "escalation": {
320-
// "reason": "BUSINESS_IMPACT",
321-
// "justification": "This is a test escalation.",
322-
// },
323-
// },
324-
// )
325-
// print(request.execute())
326-
// ```
327108
rpc EscalateCase(EscalateCaseRequest) returns (Case) {
328109
option (google.api.http) = {
329110
post: "/v2/{name=projects/*/cases/*}:escalate"
@@ -336,35 +117,6 @@ service CaseService {
336117
}
337118

338119
// Close a case.
339-
//
340-
// EXAMPLES:
341-
//
342-
// cURL:
343-
//
344-
// ```shell
345-
// case="projects/some-project/cases/43595344"
346-
// curl \
347-
// --request POST \
348-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
349-
// "https://cloudsupport.googleapis.com/v2/$case:close"
350-
// ```
351-
//
352-
// Python:
353-
//
354-
// ```python
355-
// import googleapiclient.discovery
356-
//
357-
// api_version = "v2"
358-
// supportApiService = googleapiclient.discovery.build(
359-
// serviceName="cloudsupport",
360-
// version=api_version,
361-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
362-
// )
363-
// request = supportApiService.cases().close(
364-
// name="projects/some-project/cases/43595344"
365-
// )
366-
// print(request.execute())
367-
// ```
368120
rpc CloseCase(CloseCaseRequest) returns (Case) {
369121
option (google.api.http) = {
370122
post: "/v2/{name=projects/*/cases/*}:close"
@@ -386,32 +138,6 @@ service CaseService {
386138
// months. When a classification is deactivated, this endpoint immediately
387139
// stops returning it. After six months, `case.create` requests using the
388140
// classification will fail.
389-
//
390-
// EXAMPLES:
391-
//
392-
// cURL:
393-
//
394-
// ```shell
395-
// curl \
396-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
397-
// 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
398-
// ```
399-
//
400-
// Python:
401-
//
402-
// ```python
403-
// import googleapiclient.discovery
404-
//
405-
// supportApiService = googleapiclient.discovery.build(
406-
// serviceName="cloudsupport",
407-
// version="v2",
408-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2",
409-
// )
410-
// request = supportApiService.caseClassifications().search(
411-
// query='display_name:"*Compute Engine*"'
412-
// )
413-
// print(request.execute())
414-
// ```
415141
rpc SearchCaseClassifications(SearchCaseClassificationsRequest)
416142
returns (SearchCaseClassificationsResponse) {
417143
option (google.api.http) = {

0 commit comments

Comments
 (0)