Skip to content

Commit c799c51

Browse files
Google APIscopybara-github
authored andcommitted
docs: Remove unnecessary curl and Python documentation
PiperOrigin-RevId: 761143897
1 parent a4367c5 commit c799c51

3 files changed

Lines changed: 0 additions & 372 deletions

File tree

google/cloud/support/v2beta/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/v2beta/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: "/v2beta/{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: "/v2beta/{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: "/v2beta/{parent=projects/*}/cases:search"
@@ -160,61 +75,6 @@ service CaseService {
16075
// It must have the following fields set: `display_name`, `description`,
16176
// `classification`, and `priority`. If you're just testing the API and don't
16277
// want to route your case to an agent, set `testCase=true`.
163-
//
164-
// EXAMPLES:
165-
//
166-
// cURL:
167-
//
168-
// ```shell
169-
// parent="projects/some-project"
170-
// curl \
171-
// --request POST \
172-
// --header "Authorization: Bearer $(gcloud auth print-access-token)" \
173-
// --header 'Content-Type: application/json' \
174-
// --data '{
175-
// "display_name": "Test case created by me.",
176-
// "description": "a random test case, feel free to close",
177-
// "classification": {
178-
// "id":
179-
// "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
180-
// },
181-
// "time_zone": "-07:00",
182-
// "subscriber_email_addresses": [
183-
184-
185-
// ],
186-
// "testCase": true,
187-
// "priority": "P3"
188-
// }' \
189-
// "https://cloudsupport.googleapis.com/v2/$parent/cases"
190-
// ```
191-
//
192-
// Python:
193-
//
194-
// ```python
195-
// import googleapiclient.discovery
196-
//
197-
// api_version = "v2"
198-
// supportApiService = googleapiclient.discovery.build(
199-
// serviceName="cloudsupport",
200-
// version=api_version,
201-
// discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
202-
// )
203-
// request = supportApiService.cases().create(
204-
// parent="projects/some-project",
205-
// body={
206-
// "displayName": "A Test Case",
207-
// "description": "This is a test case.",
208-
// "testCase": True,
209-
// "priority": "P2",
210-
// "classification": {
211-
// "id":
212-
// "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
213-
// },
214-
// },
215-
// )
216-
// print(request.execute())
217-
// ```
21878
rpc CreateCase(CreateCaseRequest) returns (Case) {
21979
option (google.api.http) = {
22080
post: "/v2beta/{parent=projects/*}/cases"
@@ -228,43 +88,6 @@ service CaseService {
22888
}
22989

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

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

0 commit comments

Comments
 (0)