2022-12-02 02:08:48 +03:00
|
|
|
// Copyright 2021 OpenSSF Scorecard Authors
|
2021-08-14 03:34:40 +03:00
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package clients
|
|
|
|
|
|
|
|
// SearchRequest queries a repo for `Query`.
|
2021-08-16 20:34:10 +03:00
|
|
|
// If `Filename` is provided, only matching filenames are queried.
|
|
|
|
// If `Path` is provided, only files with matching paths are queried.
|
2021-08-14 03:34:40 +03:00
|
|
|
type SearchRequest struct {
|
|
|
|
Query string
|
|
|
|
Filename string
|
2021-08-16 20:34:10 +03:00
|
|
|
Path string
|
2021-08-14 03:34:40 +03:00
|
|
|
}
|
|
|
|
|
2021-08-16 20:34:10 +03:00
|
|
|
// SearchResponse returns the results from a search request on a repo.
|
|
|
|
type SearchResponse struct {
|
|
|
|
Results []SearchResult
|
|
|
|
Hits int
|
|
|
|
}
|
|
|
|
|
|
|
|
// SearchResult represents a matching result from the search query.
|
2021-08-14 03:34:40 +03:00
|
|
|
type SearchResult struct {
|
2021-08-16 20:34:10 +03:00
|
|
|
Path string
|
2021-08-14 03:34:40 +03:00
|
|
|
}
|
2022-08-11 18:09:21 +03:00
|
|
|
|
2022-08-17 04:55:48 +03:00
|
|
|
// SearchCommitsOptions represents the parameters in the search commit query.
|
2022-08-11 18:09:21 +03:00
|
|
|
type SearchCommitsOptions struct {
|
|
|
|
Author string
|
|
|
|
}
|