search

package
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: MIT Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateCodeGetResponseFromDiscriminatorValue

CreateCodeGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateCodeResponseFromDiscriminatorValue

CreateCodeResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateCommitsGetResponseFromDiscriminatorValue

CreateCommitsGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateCommitsResponseFromDiscriminatorValue

CreateCommitsResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateIssuesGetResponseFromDiscriminatorValue

CreateIssuesGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateIssuesResponseFromDiscriminatorValue

CreateIssuesResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateLabelsGetResponseFromDiscriminatorValue

CreateLabelsGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateLabelsResponseFromDiscriminatorValue

CreateLabelsResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateRepositoriesGetResponseFromDiscriminatorValue

CreateRepositoriesGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateRepositoriesResponseFromDiscriminatorValue

CreateRepositoriesResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateTopicsGetResponseFromDiscriminatorValue

CreateTopicsGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateTopicsResponseFromDiscriminatorValue

CreateTopicsResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateUsersGetResponseFromDiscriminatorValue

CreateUsersGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateUsersResponseFromDiscriminatorValue

CreateUsersResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

Types

type CodeGetResponse

type CodeGetResponse struct {
	// contains filtered or unexported fields
}

func NewCodeGetResponse

func NewCodeGetResponse() *CodeGetResponse

NewCodeGetResponse instantiates a new CodeGetResponse and sets the default values.

func (*CodeGetResponse) GetAdditionalData

func (m *CodeGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*CodeGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*CodeGetResponse) GetIncompleteResults

func (m *CodeGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*CodeGetResponse) GetItems

GetItems gets the items property value. The items property returns a []CodeSearchResultItemable when successful

func (*CodeGetResponse) GetTotalCount

func (m *CodeGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*CodeGetResponse) Serialize

Serialize serializes information the current object

func (*CodeGetResponse) SetAdditionalData

func (m *CodeGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*CodeGetResponse) SetIncompleteResults

func (m *CodeGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*CodeGetResponse) SetItems

SetItems sets the items property value. The items property

func (*CodeGetResponse) SetTotalCount

func (m *CodeGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type CodeRequestBuilder

CodeRequestBuilder builds and executes requests for operations under \search\code

func NewCodeRequestBuilder

NewCodeRequestBuilder instantiates a new CodeRequestBuilder and sets the default values.

func NewCodeRequestBuilderInternal

func NewCodeRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *CodeRequestBuilder

NewCodeRequestBuilderInternal instantiates a new CodeRequestBuilder and sets the default values.

func (*CodeRequestBuilder) Get

Get searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:`q=addClass+in:file+language:js+repo:jquery/jquery`This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.Considerations for code search:Due to the complexity of searching code, there are a few restrictions on how searches are performed:* Only the _default branch_ is considered. In most cases, this will be the `master` branch.* Only files smaller than 384 KB are searchable.* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazinglanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.This endpoint requires you to authenticate and limits you to 10 requests per minute. returns a CodeGetResponseable when successful returns a BasicError error when the service returns a 403 status code returns a ValidationError error when the service returns a 422 status code returns a Code503Error error when the service returns a 503 status code API method documentation

func (*CodeRequestBuilder) ToGetRequestInformation

ToGetRequestInformation searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:`q=addClass+in:file+language:js+repo:jquery/jquery`This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.Considerations for code search:Due to the complexity of searching code, there are a few restrictions on how searches are performed:* Only the _default branch_ is considered. In most cases, this will be the `master` branch.* Only files smaller than 384 KB are searchable.* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazinglanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.This endpoint requires you to authenticate and limits you to 10 requests per minute. returns a *RequestInformation when successful

func (*CodeRequestBuilder) WithUrl

func (m *CodeRequestBuilder) WithUrl(rawUrl string) *CodeRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *CodeRequestBuilder when successful

type CodeRequestBuilderGetQueryParameters

type CodeRequestBuilderGetQueryParameters struct {
	// **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	// Deprecated:
	Order *i077352aa902c51bfc500a83132f68b8da1051f8b770660094032b189b1a9f293.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers.
	Q *string `uriparametername:"q"`
	// **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	// Deprecated:
	Sort *i077352aa902c51bfc500a83132f68b8da1051f8b770660094032b189b1a9f293.GetSortQueryParameterType `uriparametername:"sort"`
}

CodeRequestBuilderGetQueryParameters searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:`q=addClass+in:file+language:js+repo:jquery/jquery`This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.Considerations for code search:Due to the complexity of searching code, there are a few restrictions on how searches are performed:* Only the _default branch_ is considered. In most cases, this will be the `master` branch.* Only files smaller than 384 KB are searchable.* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazinglanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.This endpoint requires you to authenticate and limits you to 10 requests per minute.

type CodeResponse

type CodeResponse struct {
	CodeGetResponse
}

CodeResponse Deprecated: This class is obsolete. Use codeGetResponse instead.

func NewCodeResponse

func NewCodeResponse() *CodeResponse

NewCodeResponse instantiates a new CodeResponse and sets the default values.

type CodeResponseable

CodeResponseable Deprecated: This class is obsolete. Use codeGetResponse instead.

type CommitsGetResponse

type CommitsGetResponse struct {
	// contains filtered or unexported fields
}

func NewCommitsGetResponse

func NewCommitsGetResponse() *CommitsGetResponse

NewCommitsGetResponse instantiates a new CommitsGetResponse and sets the default values.

func (*CommitsGetResponse) GetAdditionalData

func (m *CommitsGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*CommitsGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*CommitsGetResponse) GetIncompleteResults

func (m *CommitsGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*CommitsGetResponse) GetItems

GetItems gets the items property value. The items property returns a []CommitSearchResultItemable when successful

func (*CommitsGetResponse) GetTotalCount

func (m *CommitsGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*CommitsGetResponse) Serialize

Serialize serializes information the current object

func (*CommitsGetResponse) SetAdditionalData

func (m *CommitsGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*CommitsGetResponse) SetIncompleteResults

func (m *CommitsGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*CommitsGetResponse) SetItems

SetItems sets the items property value. The items property

func (*CommitsGetResponse) SetTotalCount

func (m *CommitsGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type CommitsRequestBuilder

CommitsRequestBuilder builds and executes requests for operations under \search\commits

func NewCommitsRequestBuilder

NewCommitsRequestBuilder instantiates a new CommitsRequestBuilder and sets the default values.

func NewCommitsRequestBuilderInternal

func NewCommitsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *CommitsRequestBuilder

NewCommitsRequestBuilderInternal instantiates a new CommitsRequestBuilder and sets the default values.

func (*CommitsRequestBuilder) Get

Get find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text matchmetadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find commits related to CSS in the octocat/Spoon-Knife(https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:`q=repo:octocat/Spoon-Knife+css` returns a CommitsGetResponseable when successful API method documentation

func (*CommitsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text matchmetadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find commits related to CSS in the octocat/Spoon-Knife(https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:`q=repo:octocat/Spoon-Knife+css` returns a *RequestInformation when successful

func (*CommitsRequestBuilder) WithUrl

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *CommitsRequestBuilder when successful

type CommitsRequestBuilderGetQueryParameters

type CommitsRequestBuilderGetQueryParameters struct {
	// Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	Order *i625e45c268d4ab4a42a97d02ce2d6719584691128398ca7ec6cca25ecc82eda8.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers.
	Q *string `uriparametername:"q"`
	// Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	Sort *i625e45c268d4ab4a42a97d02ce2d6719584691128398ca7ec6cca25ecc82eda8.GetSortQueryParameterType `uriparametername:"sort"`
}

CommitsRequestBuilderGetQueryParameters find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text matchmetadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find commits related to CSS in the octocat/Spoon-Knife(https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:`q=repo:octocat/Spoon-Knife+css`

type CommitsResponse

type CommitsResponse struct {
	CommitsGetResponse
}

CommitsResponse Deprecated: This class is obsolete. Use commitsGetResponse instead.

func NewCommitsResponse

func NewCommitsResponse() *CommitsResponse

NewCommitsResponse instantiates a new CommitsResponse and sets the default values.

type CommitsResponseable

CommitsResponseable Deprecated: This class is obsolete. Use commitsGetResponse instead.

type IssuesGetResponse

type IssuesGetResponse struct {
	// contains filtered or unexported fields
}

func NewIssuesGetResponse

func NewIssuesGetResponse() *IssuesGetResponse

NewIssuesGetResponse instantiates a new IssuesGetResponse and sets the default values.

func (*IssuesGetResponse) GetAdditionalData

func (m *IssuesGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*IssuesGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*IssuesGetResponse) GetIncompleteResults

func (m *IssuesGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*IssuesGetResponse) GetItems

GetItems gets the items property value. The items property returns a []IssueSearchResultItemable when successful

func (*IssuesGetResponse) GetTotalCount

func (m *IssuesGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*IssuesGetResponse) Serialize

Serialize serializes information the current object

func (*IssuesGetResponse) SetAdditionalData

func (m *IssuesGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*IssuesGetResponse) SetIncompleteResults

func (m *IssuesGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*IssuesGetResponse) SetItems

SetItems sets the items property value. The items property

func (*IssuesGetResponse) SetTotalCount

func (m *IssuesGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type IssuesRequestBuilder

IssuesRequestBuilder builds and executes requests for operations under \search\issues

func NewIssuesRequestBuilder

NewIssuesRequestBuilder instantiates a new IssuesRequestBuilder and sets the default values.

func NewIssuesRequestBuilderInternal

func NewIssuesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *IssuesRequestBuilder

NewIssuesRequestBuilderInternal instantiates a new IssuesRequestBuilder and sets the default values.

func (*IssuesRequestBuilder) Get

Get find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlightedsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.`q=windows+label:bug+language:python+state:open&sort=created&order=asc`This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." returns a IssuesGetResponseable when successful returns a BasicError error when the service returns a 403 status code returns a ValidationError error when the service returns a 422 status code returns a Issues503Error error when the service returns a 503 status code API method documentation

func (*IssuesRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlightedsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.`q=windows+label:bug+language:python+state:open&sort=created&order=asc`This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." returns a *RequestInformation when successful

func (*IssuesRequestBuilder) WithUrl

func (m *IssuesRequestBuilder) WithUrl(rawUrl string) *IssuesRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *IssuesRequestBuilder when successful

type IssuesRequestBuilderGetQueryParameters

type IssuesRequestBuilderGetQueryParameters struct {
	// Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	Order *i60f7782ca360402c5ca504d6e0a3ccd1fa72dc30352dc710edab252368039c3f.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers.
	Q *string `uriparametername:"q"`
	// Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	Sort *i60f7782ca360402c5ca504d6e0a3ccd1fa72dc30352dc710edab252368039c3f.GetSortQueryParameterType `uriparametername:"sort"`
}

IssuesRequestBuilderGetQueryParameters find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlightedsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.`q=windows+label:bug+language:python+state:open&sort=created&order=asc`This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."

type IssuesResponse

type IssuesResponse struct {
	IssuesGetResponse
}

IssuesResponse Deprecated: This class is obsolete. Use issuesGetResponse instead.

func NewIssuesResponse

func NewIssuesResponse() *IssuesResponse

NewIssuesResponse instantiates a new IssuesResponse and sets the default values.

type IssuesResponseable

IssuesResponseable Deprecated: This class is obsolete. Use issuesGetResponse instead.

type LabelsGetResponse

type LabelsGetResponse struct {
	// contains filtered or unexported fields
}

func NewLabelsGetResponse

func NewLabelsGetResponse() *LabelsGetResponse

NewLabelsGetResponse instantiates a new LabelsGetResponse and sets the default values.

func (*LabelsGetResponse) GetAdditionalData

func (m *LabelsGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*LabelsGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*LabelsGetResponse) GetIncompleteResults

func (m *LabelsGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*LabelsGetResponse) GetItems

GetItems gets the items property value. The items property returns a []LabelSearchResultItemable when successful

func (*LabelsGetResponse) GetTotalCount

func (m *LabelsGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*LabelsGetResponse) Serialize

Serialize serializes information the current object

func (*LabelsGetResponse) SetAdditionalData

func (m *LabelsGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*LabelsGetResponse) SetIncompleteResults

func (m *LabelsGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*LabelsGetResponse) SetItems

SetItems sets the items property value. The items property

func (*LabelsGetResponse) SetTotalCount

func (m *LabelsGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type LabelsRequestBuilder

LabelsRequestBuilder builds and executes requests for operations under \search\labels

func NewLabelsRequestBuilder

NewLabelsRequestBuilder instantiates a new LabelsRequestBuilder and sets the default values.

func NewLabelsRequestBuilderInternal

func NewLabelsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *LabelsRequestBuilder

NewLabelsRequestBuilderInternal instantiates a new LabelsRequestBuilder and sets the default values.

func (*LabelsRequestBuilder) Get

Get find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:`q=bug+defect+enhancement&repository_id=64778136`The labels that best match the query appear first in the search results. returns a LabelsGetResponseable when successful returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a ValidationError error when the service returns a 422 status code API method documentation

func (*LabelsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:`q=bug+defect+enhancement&repository_id=64778136`The labels that best match the query appear first in the search results. returns a *RequestInformation when successful

func (*LabelsRequestBuilder) WithUrl

func (m *LabelsRequestBuilder) WithUrl(rawUrl string) *LabelsRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *LabelsRequestBuilder when successful

type LabelsRequestBuilderGetQueryParameters

type LabelsRequestBuilderGetQueryParameters struct {
	// Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	Order *i7add74210511a3bba07275779ce4518d4e5b8c0b4c74994de39cfb93f5b96ecf.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).
	Q *string `uriparametername:"q"`
	// The id of the repository.
	Repository_id *int32 `uriparametername:"repository_id"`
	// Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	Sort *i7add74210511a3bba07275779ce4518d4e5b8c0b4c74994de39cfb93f5b96ecf.GetSortQueryParameterType `uriparametername:"sort"`
}

LabelsRequestBuilderGetQueryParameters find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:`q=bug+defect+enhancement&repository_id=64778136`The labels that best match the query appear first in the search results.

type LabelsResponse

type LabelsResponse struct {
	LabelsGetResponse
}

LabelsResponse Deprecated: This class is obsolete. Use labelsGetResponse instead.

func NewLabelsResponse

func NewLabelsResponse() *LabelsResponse

NewLabelsResponse instantiates a new LabelsResponse and sets the default values.

type LabelsResponseable

LabelsResponseable Deprecated: This class is obsolete. Use labelsGetResponse instead.

type RepositoriesGetResponse

type RepositoriesGetResponse struct {
	// contains filtered or unexported fields
}

func NewRepositoriesGetResponse

func NewRepositoriesGetResponse() *RepositoriesGetResponse

NewRepositoriesGetResponse instantiates a new RepositoriesGetResponse and sets the default values.

func (*RepositoriesGetResponse) GetAdditionalData

func (m *RepositoriesGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*RepositoriesGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*RepositoriesGetResponse) GetIncompleteResults

func (m *RepositoriesGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*RepositoriesGetResponse) GetItems

GetItems gets the items property value. The items property returns a []RepoSearchResultItemable when successful

func (*RepositoriesGetResponse) GetTotalCount

func (m *RepositoriesGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*RepositoriesGetResponse) Serialize

Serialize serializes information the current object

func (*RepositoriesGetResponse) SetAdditionalData

func (m *RepositoriesGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*RepositoriesGetResponse) SetIncompleteResults

func (m *RepositoriesGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*RepositoriesGetResponse) SetItems

SetItems sets the items property value. The items property

func (*RepositoriesGetResponse) SetTotalCount

func (m *RepositoriesGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type RepositoriesRequestBuilder

RepositoriesRequestBuilder builds and executes requests for operations under \search\repositories

func NewRepositoriesRequestBuilder

NewRepositoriesRequestBuilder instantiates a new RepositoriesRequestBuilder and sets the default values.

func NewRepositoriesRequestBuilderInternal

func NewRepositoriesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *RepositoriesRequestBuilder

NewRepositoriesRequestBuilderInternal instantiates a new RepositoriesRequestBuilder and sets the default values.

func (*RepositoriesRequestBuilder) Get

Get find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:`q=tetris+language:assembly&sort=stars&order=desc`This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. returns a RepositoriesGetResponseable when successful returns a ValidationError error when the service returns a 422 status code returns a Repositories503Error error when the service returns a 503 status code API method documentation

func (*RepositoriesRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:`q=tetris+language:assembly&sort=stars&order=desc`This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. returns a *RequestInformation when successful

func (*RepositoriesRequestBuilder) WithUrl

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *RepositoriesRequestBuilder when successful

type RepositoriesRequestBuilderGetQueryParameters

type RepositoriesRequestBuilderGetQueryParameters struct {
	// Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	Order *if00612db3ee43f8c11c434312c0490ee1b643ea9471a2b1c2a889018d89cf8b3.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.
	Q *string `uriparametername:"q"`
	// Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	Sort *if00612db3ee43f8c11c434312c0490ee1b643ea9471a2b1c2a889018d89cf8b3.GetSortQueryParameterType `uriparametername:"sort"`
}

RepositoriesRequestBuilderGetQueryParameters find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:`q=tetris+language:assembly&sort=stars&order=desc`This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

type RepositoriesResponse

type RepositoriesResponse struct {
	RepositoriesGetResponse
}

RepositoriesResponse Deprecated: This class is obsolete. Use repositoriesGetResponse instead.

func NewRepositoriesResponse

func NewRepositoriesResponse() *RepositoriesResponse

NewRepositoriesResponse instantiates a new RepositoriesResponse and sets the default values.

type RepositoriesResponseable

RepositoriesResponseable Deprecated: This class is obsolete. Use repositoriesGetResponse instead.

type SearchRequestBuilder

SearchRequestBuilder builds and executes requests for operations under \search

func NewSearchRequestBuilder

NewSearchRequestBuilder instantiates a new SearchRequestBuilder and sets the default values.

func NewSearchRequestBuilderInternal

func NewSearchRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SearchRequestBuilder

NewSearchRequestBuilderInternal instantiates a new SearchRequestBuilder and sets the default values.

func (*SearchRequestBuilder) Code

Code the code property returns a *CodeRequestBuilder when successful

func (*SearchRequestBuilder) Commits

Commits the commits property returns a *CommitsRequestBuilder when successful

func (*SearchRequestBuilder) Issues

Issues the issues property returns a *IssuesRequestBuilder when successful

func (*SearchRequestBuilder) Labels

Labels the labels property returns a *LabelsRequestBuilder when successful

func (*SearchRequestBuilder) Repositories

Repositories the repositories property returns a *RepositoriesRequestBuilder when successful

func (*SearchRequestBuilder) Topics

Topics the topics property returns a *TopicsRequestBuilder when successful

func (*SearchRequestBuilder) Users

Users the users property returns a *UsersRequestBuilder when successful

type TopicsGetResponse

type TopicsGetResponse struct {
	// contains filtered or unexported fields
}

func NewTopicsGetResponse

func NewTopicsGetResponse() *TopicsGetResponse

NewTopicsGetResponse instantiates a new TopicsGetResponse and sets the default values.

func (*TopicsGetResponse) GetAdditionalData

func (m *TopicsGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*TopicsGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*TopicsGetResponse) GetIncompleteResults

func (m *TopicsGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*TopicsGetResponse) GetItems

GetItems gets the items property value. The items property returns a []TopicSearchResultItemable when successful

func (*TopicsGetResponse) GetTotalCount

func (m *TopicsGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*TopicsGetResponse) Serialize

Serialize serializes information the current object

func (*TopicsGetResponse) SetAdditionalData

func (m *TopicsGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*TopicsGetResponse) SetIncompleteResults

func (m *TopicsGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*TopicsGetResponse) SetItems

SetItems sets the items property value. The items property

func (*TopicsGetResponse) SetTotalCount

func (m *TopicsGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type TopicsRequestBuilder

TopicsRequestBuilder builds and executes requests for operations under \search\topics

func NewTopicsRequestBuilder

NewTopicsRequestBuilder instantiates a new TopicsRequestBuilder and sets the default values.

func NewTopicsRequestBuilderInternal

func NewTopicsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *TopicsRequestBuilder

NewTopicsRequestBuilderInternal instantiates a new TopicsRequestBuilder and sets the default values.

func (*TopicsRequestBuilder) Get

Get find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:`q=ruby+is:featured`This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. returns a TopicsGetResponseable when successful API method documentation

func (*TopicsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:`q=ruby+is:featured`This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. returns a *RequestInformation when successful

func (*TopicsRequestBuilder) WithUrl

func (m *TopicsRequestBuilder) WithUrl(rawUrl string) *TopicsRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *TopicsRequestBuilder when successful

type TopicsRequestBuilderGetQueryParameters

type TopicsRequestBuilderGetQueryParameters struct {
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).
	Q *string `uriparametername:"q"`
}

TopicsRequestBuilderGetQueryParameters find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:`q=ruby+is:featured`This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

type TopicsResponse

type TopicsResponse struct {
	TopicsGetResponse
}

TopicsResponse Deprecated: This class is obsolete. Use topicsGetResponse instead.

func NewTopicsResponse

func NewTopicsResponse() *TopicsResponse

NewTopicsResponse instantiates a new TopicsResponse and sets the default values.

type TopicsResponseable

TopicsResponseable Deprecated: This class is obsolete. Use topicsGetResponse instead.

type UsersGetResponse

type UsersGetResponse struct {
	// contains filtered or unexported fields
}

func NewUsersGetResponse

func NewUsersGetResponse() *UsersGetResponse

NewUsersGetResponse instantiates a new UsersGetResponse and sets the default values.

func (*UsersGetResponse) GetAdditionalData

func (m *UsersGetResponse) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*UsersGetResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*UsersGetResponse) GetIncompleteResults

func (m *UsersGetResponse) GetIncompleteResults() *bool

GetIncompleteResults gets the incomplete_results property value. The incomplete_results property returns a *bool when successful

func (*UsersGetResponse) GetItems

GetItems gets the items property value. The items property returns a []UserSearchResultItemable when successful

func (*UsersGetResponse) GetTotalCount

func (m *UsersGetResponse) GetTotalCount() *int32

GetTotalCount gets the total_count property value. The total_count property returns a *int32 when successful

func (*UsersGetResponse) Serialize

Serialize serializes information the current object

func (*UsersGetResponse) SetAdditionalData

func (m *UsersGetResponse) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*UsersGetResponse) SetIncompleteResults

func (m *UsersGetResponse) SetIncompleteResults(value *bool)

SetIncompleteResults sets the incomplete_results property value. The incomplete_results property

func (*UsersGetResponse) SetItems

SetItems sets the items property value. The items property

func (*UsersGetResponse) SetTotalCount

func (m *UsersGetResponse) SetTotalCount(value *int32)

SetTotalCount sets the total_count property value. The total_count property

type UsersRequestBuilder

UsersRequestBuilder builds and executes requests for operations under \search\users

func NewUsersRequestBuilder

NewUsersRequestBuilder instantiates a new UsersRequestBuilder and sets the default values.

func NewUsersRequestBuilderInternal

func NewUsersRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *UsersRequestBuilder

NewUsersRequestBuilderInternal instantiates a new UsersRequestBuilder and sets the default values.

func (*UsersRequestBuilder) Get

Get find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you're looking for a list of popular users, you might try this query:`q=tom+repos:%3E42+followers:%3E1000`This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." returns a UsersGetResponseable when successful returns a ValidationError error when the service returns a 422 status code returns a Users503Error error when the service returns a 503 status code API method documentation

func (*UsersRequestBuilder) ToGetRequestInformation

ToGetRequestInformation find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you're looking for a list of popular users, you might try this query:`q=tom+repos:%3E42+followers:%3E1000`This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." returns a *RequestInformation when successful

func (*UsersRequestBuilder) WithUrl

func (m *UsersRequestBuilder) WithUrl(rawUrl string) *UsersRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *UsersRequestBuilder when successful

type UsersRequestBuilderGetQueryParameters

type UsersRequestBuilderGetQueryParameters struct {
	// Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
	Order *i4bbf61dd92ec14fb80440b575ce08a197a518044325eb9dc0b476c3deafdcfbd.GetOrderQueryParameterType `uriparametername:"order"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Per_page *int32 `uriparametername:"per_page"`
	// The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers.
	Q *string `uriparametername:"q"`
	// Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
	Sort *i4bbf61dd92ec14fb80440b575ce08a197a518044325eb9dc0b476c3deafdcfbd.GetSortQueryParameterType `uriparametername:"sort"`
}

UsersRequestBuilderGetQueryParameters find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).For example, if you're looking for a list of popular users, you might try this query:`q=tom+repos:%3E42+followers:%3E1000`This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)."

type UsersResponse

type UsersResponse struct {
	UsersGetResponse
}

UsersResponse Deprecated: This class is obsolete. Use usersGetResponse instead.

func NewUsersResponse

func NewUsersResponse() *UsersResponse

NewUsersResponse instantiates a new UsersResponse and sets the default values.

type UsersResponseable

UsersResponseable Deprecated: This class is obsolete. Use usersGetResponse instead.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL