Skip to content

Commit de951c3

Browse files
yoshi-automationyoshi-automation
committed
feat(checks): update the api
#### checks:v1alpha The following keys were added: - resources.accounts.resources.repos.resources.scans.methods.generate (Total Keys: 11) - resources.accounts.resources.repos.resources.scans.methods.get (Total Keys: 10) - resources.accounts.resources.repos.resources.scans.methods.list (Total Keys: 17) - schemas.GoogleChecksRepoScanV1alphaCliAnalysis (Total Keys: 6) - schemas.GoogleChecksRepoScanV1alphaCodeAttribution (Total Keys: 4) - schemas.GoogleChecksRepoScanV1alphaCodeScan (Total Keys: 8) - schemas.GoogleChecksRepoScanV1alphaGenerateScanRequest (Total Keys: 6) - schemas.GoogleChecksRepoScanV1alphaListRepoScansResponse (Total Keys: 5) - schemas.GoogleChecksRepoScanV1alphaPullRequest (Total Keys: 4) - schemas.GoogleChecksRepoScanV1alphaRepoScan (Total Keys: 9) - schemas.GoogleChecksRepoScanV1alphaScmMetadata (Total Keys: 5) - schemas.GoogleChecksRepoScanV1alphaSource (Total Keys: 12)
1 parent 198e957 commit de951c3

File tree

3 files changed

+777
-1
lines changed

3 files changed

+777
-1
lines changed

‎docs/dyn/checks_v1alpha.accounts.repos.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the operations Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="checks_v1alpha.accounts.repos.scans.html">scans()</a></code>
84+
</p>
85+
<p class="firstline">Returns the scans Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="#close">close()</a></code></p>
8489
<p class="firstline">Close httplib2 connections.</p>

‎docs/dyn/checks_v1alpha.accounts.repos.scans.html

Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,285 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="checks_v1alpha.html">Checks API</a> . <a href="checks_v1alpha.accounts.html">accounts</a> . <a href="checks_v1alpha.accounts.repos.html">repos</a> . <a href="checks_v1alpha.accounts.repos.scans.html">scans</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.</p>
83+
<p class="toc_element">
84+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.</p>
86+
<p class="toc_element">
87+
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Lists repo scans for the specified repo.</p>
89+
<p class="toc_element">
90+
<code><a href="#list_next">list_next()</a></code></p>
91+
<p class="firstline">Retrieves the next page of results.</p>
92+
<h3>Method Details</h3>
93+
<div class="method">
94+
<code class="details" id="close">close()</code>
95+
<pre>Close httplib2 connections.</pre>
96+
</div>
97+
98+
<div class="method">
99+
<code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
100+
<pre>Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.
101+
102+
Args:
103+
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
104+
body: object, The request body.
105+
The object takes the form of:
106+
107+
{ # The request message for RepoScanService.GenerateScan.
108+
&quot;cliAnalysis&quot;: { # The results of a Code Compliance CLI analysis. # Required. CLI analysis results.
109+
&quot;codeScans&quot;: [ # Optional. Requested code scans resulting from preliminary CLI analysis.
110+
{ # A requested analysis of source code. Contains the source code and processing state.
111+
&quot;dataTypeClassifications&quot;: [ # Optional. Data type classification requests.
112+
{ # A request to classify data types.
113+
&quot;dataType&quot;: &quot;A String&quot;, # Required. Candidate data type.
114+
&quot;lineNumber&quot;: 42, # Required. Line number (1-based).
115+
},
116+
],
117+
&quot;sourceCode&quot;: { # Contains source code from a repo. # Required. Source code to analyze.
118+
&quot;code&quot;: &quot;A String&quot;, # Required. Source code.
119+
&quot;endLine&quot;: 42, # Required. End line number (1-based).
120+
&quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
121+
&quot;startLine&quot;: 42, # Required. Start line number (1-based).
122+
},
123+
},
124+
],
125+
&quot;sources&quot;: [ # Optional. Data sources detected in the scan.
126+
{ # Represents a data source finding.
127+
&quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
128+
&quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
129+
&quot;lineNumber&quot;: 42, # Required. Line number (1-based).
130+
&quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
131+
&quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
132+
},
133+
&quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
134+
},
135+
],
136+
},
137+
&quot;cliVersion&quot;: &quot;A String&quot;, # Required. CLI version.
138+
&quot;localScanPath&quot;: &quot;A String&quot;, # Required. Local scan path.
139+
&quot;scmMetadata&quot;: { # SCM metadata. # Required. SCM metadata.
140+
&quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
141+
&quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
142+
&quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
143+
&quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
144+
},
145+
&quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
146+
&quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
147+
},
148+
}
149+
150+
x__xgafv: string, V1 error format.
151+
Allowed values
152+
1 - v1 error format
153+
2 - v2 error format
154+
155+
Returns:
156+
An object of the form:
157+
158+
{ # This resource represents a long-running operation that is the result of a network API call.
159+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
160+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
161+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
162+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
163+
{
164+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165+
},
166+
],
167+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
168+
},
169+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
170+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171+
},
172+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
173+
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
174+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175+
},
176+
}</pre>
177+
</div>
178+
179+
<div class="method">
180+
<code class="details" id="get">get(name, x__xgafv=None)</code>
181+
<pre>Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.
182+
183+
Args:
184+
name: string, Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789` (required)
185+
x__xgafv: string, V1 error format.
186+
Allowed values
187+
1 - v1 error format
188+
2 - v2 error format
189+
190+
Returns:
191+
An object of the form:
192+
193+
{ # Repo scan.
194+
&quot;cliVersion&quot;: &quot;A String&quot;, # CLI version.
195+
&quot;localScanPath&quot;: &quot;A String&quot;, # Local scan path.
196+
&quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the scan.
197+
&quot;resultsUri&quot;: &quot;A String&quot;, # A URL to view results.
198+
&quot;scmMetadata&quot;: { # SCM metadata. # SCM metadata.
199+
&quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
200+
&quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
201+
&quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
202+
&quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
203+
},
204+
&quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
205+
&quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
206+
},
207+
&quot;sources&quot;: [ # Data sources detected.
208+
{ # Represents a data source finding.
209+
&quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
210+
&quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
211+
&quot;lineNumber&quot;: 42, # Required. Line number (1-based).
212+
&quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
213+
&quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
214+
},
215+
&quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
216+
},
217+
],
218+
}</pre>
219+
</div>
220+
221+
<div class="method">
222+
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
223+
<pre>Lists repo scans for the specified repo.
224+
225+
Args:
226+
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
227+
filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main`
228+
pageSize: integer, Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.
229+
pageToken: string, Optional. A page token received from a previous `ListRepoScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepoScans` must match the call that provided the page token.
230+
x__xgafv: string, V1 error format.
231+
Allowed values
232+
1 - v1 error format
233+
2 - v2 error format
234+
235+
Returns:
236+
An object of the form:
237+
238+
{ # The response message for RepoScanService.ListRepoScans.
239+
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
240+
&quot;repoScans&quot;: [ # The repo scans for the specified app.
241+
{ # Repo scan.
242+
&quot;cliVersion&quot;: &quot;A String&quot;, # CLI version.
243+
&quot;localScanPath&quot;: &quot;A String&quot;, # Local scan path.
244+
&quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the scan.
245+
&quot;resultsUri&quot;: &quot;A String&quot;, # A URL to view results.
246+
&quot;scmMetadata&quot;: { # SCM metadata. # SCM metadata.
247+
&quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
248+
&quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
249+
&quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
250+
&quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
251+
},
252+
&quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
253+
&quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
254+
},
255+
&quot;sources&quot;: [ # Data sources detected.
256+
{ # Represents a data source finding.
257+
&quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
258+
&quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
259+
&quot;lineNumber&quot;: 42, # Required. Line number (1-based).
260+
&quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
261+
&quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
262+
},
263+
&quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
264+
},
265+
],
266+
},
267+
],
268+
}</pre>
269+
</div>
270+
271+
<div class="method">
272+
<code class="details" id="list_next">list_next()</code>
273+
<pre>Retrieves the next page of results.
274+
275+
Args:
276+
previous_request: The request for the previous page. (required)
277+
previous_response: The response from the request for the previous page. (required)
278+
279+
Returns:
280+
A request object that you can call &#x27;execute()&#x27; on to request the next
281+
page. Returns None if there are no more items in the collection.
282+
</pre>
283+
</div>
284+
285+
</body></html>

0 commit comments

Comments
 (0)