Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2024-10-20 00:07:56 +00:00
parent ee6f6ad170
commit 2366a6a2ef
2 changed files with 58 additions and 55 deletions
+34 -34
View File
@@ -5631,23 +5631,23 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
IssueApi apiInstance = new IssueApi();
String state = "state_example"; // String | whether issue is open or closed
String labels = "labels_example"; // String | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded
String milestones = "milestones_example"; // String | comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded
String q = "q_example"; // String | search string
Long priorityRepoId = 789L; // Long | repository to prioritize in the results
String type = "type_example"; // String | filter by type (issues / pulls) if set
Date since = new Date(); // Date | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
Date before = new Date(); // Date | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
Boolean assigned = true; // Boolean | filter (issues / pulls) assigned to you, default is false
Boolean created = true; // Boolean | filter (issues / pulls) created by you, default is false
Boolean mentioned = true; // Boolean | filter (issues / pulls) mentioning you, default is false
Boolean reviewRequested = true; // Boolean | filter pulls requesting your review, default is false
Boolean reviewed = true; // Boolean | filter pulls reviewed by you, default is false
String owner = "owner_example"; // String | filter by owner
String team = "team_example"; // String | filter by team (requires organization owner parameter to be provided)
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
String state = "open"; // String | State of the issue
String labels = "labels_example"; // String | Comma-separated list of label names. Fetch only issues that have any of these labels. Non existent labels are discarded.
String milestones = "milestones_example"; // String | Comma-separated list of milestone names. Fetch only issues that have any of these milestones. Non existent milestones are discarded.
String q = "q_example"; // String | Search string
Long priorityRepoId = 789L; // Long | Repository ID to prioritize in the results
String type = "type_example"; // String | Filter by issue type
Date since = new Date(); // Date | Only show issues updated after the given time (RFC 3339 format)
Date before = new Date(); // Date | Only show issues updated before the given time (RFC 3339 format)
Boolean assigned = false; // Boolean | Filter issues or pulls assigned to the authenticated user
Boolean created = false; // Boolean | Filter issues or pulls created by the authenticated user
Boolean mentioned = false; // Boolean | Filter issues or pulls mentioning the authenticated user
Boolean reviewRequested = false; // Boolean | Filter pull requests where the authenticated user's review was requested
Boolean reviewed = false; // Boolean | Filter pull requests reviewed by the authenticated user
String owner = "owner_example"; // String | Filter by repository owner
String team = "team_example"; // String | Filter by team (requires organization owner parameter)
Integer page = 1; // Integer | Page number of results to return (1-based)
Integer limit = 56; // Integer | Number of items per page
try {
List<Issue> result = apiInstance.issueSearchIssues(state, labels, milestones, q, priorityRepoId, type, since, before, assigned, created, mentioned, reviewRequested, reviewed, owner, team, page, limit);
System.out.println(result);
@@ -5661,23 +5661,23 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**state** | **String**| whether issue is open or closed | [optional]
**labels** | **String**| comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded | [optional]
**milestones** | **String**| comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded | [optional]
**q** | **String**| search string | [optional]
**priorityRepoId** | **Long**| repository to prioritize in the results | [optional]
**type** | **String**| filter by type (issues / pulls) if set | [optional]
**since** | **Date**| Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | [optional]
**before** | **Date**| Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | [optional]
**assigned** | **Boolean**| filter (issues / pulls) assigned to you, default is false | [optional]
**created** | **Boolean**| filter (issues / pulls) created by you, default is false | [optional]
**mentioned** | **Boolean**| filter (issues / pulls) mentioning you, default is false | [optional]
**reviewRequested** | **Boolean**| filter pulls requesting your review, default is false | [optional]
**reviewed** | **Boolean**| filter pulls reviewed by you, default is false | [optional]
**owner** | **String**| filter by owner | [optional]
**team** | **String**| filter by team (requires organization owner parameter to be provided) | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
**state** | **String**| State of the issue | [optional] [default to open] [enum: open, closed, all]
**labels** | **String**| Comma-separated list of label names. Fetch only issues that have any of these labels. Non existent labels are discarded. | [optional]
**milestones** | **String**| Comma-separated list of milestone names. Fetch only issues that have any of these milestones. Non existent milestones are discarded. | [optional]
**q** | **String**| Search string | [optional]
**priorityRepoId** | **Long**| Repository ID to prioritize in the results | [optional]
**type** | **String**| Filter by issue type | [optional] [enum: issues, pulls]
**since** | **Date**| Only show issues updated after the given time (RFC 3339 format) | [optional]
**before** | **Date**| Only show issues updated before the given time (RFC 3339 format) | [optional]
**assigned** | **Boolean**| Filter issues or pulls assigned to the authenticated user | [optional] [default to false]
**created** | **Boolean**| Filter issues or pulls created by the authenticated user | [optional] [default to false]
**mentioned** | **Boolean**| Filter issues or pulls mentioning the authenticated user | [optional] [default to false]
**reviewRequested** | **Boolean**| Filter pull requests where the authenticated user&#x27;s review was requested | [optional] [default to false]
**reviewed** | **Boolean**| Filter pull requests reviewed by the authenticated user | [optional] [default to false]
**owner** | **String**| Filter by repository owner | [optional]
**team** | **String**| Filter by team (requires organization owner parameter) | [optional]
**page** | **Integer**| Page number of results to return (1-based) | [optional] [default to 1] [enum: ]
**limit** | **Integer**| Number of items per page | [optional] [enum: ]
### Return type
@@ -1034,27 +1034,30 @@ public interface IssueApi {
/**
* Search for issues across the repositories that the user has access to
*
* @param state whether issue is open or closed (optional)
* @param labels comma separated list of labels. Fetch only issues that have any of this labels.
* Non existent labels are discarded (optional)
* @param milestones comma separated list of milestone names. Fetch only issues that have any of
* this milestones. Non existent are discarded (optional)
* @param q search string (optional)
* @param priorityRepoId repository to prioritize in the results (optional)
* @param type filter by type (issues / pulls) if set (optional)
* @param since Only show notifications updated after the given time. This is a timestamp in RFC
* 3339 format (optional)
* @param before Only show notifications updated before the given time. This is a timestamp in RFC
* 3339 format (optional)
* @param assigned filter (issues / pulls) assigned to you, default is false (optional)
* @param created filter (issues / pulls) created by you, default is false (optional)
* @param mentioned filter (issues / pulls) mentioning you, default is false (optional)
* @param reviewRequested filter pulls requesting your review, default is false (optional)
* @param reviewed filter pulls reviewed by you, default is false (optional)
* @param owner filter by owner (optional)
* @param team filter by team (requires organization owner parameter to be provided) (optional)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @param state State of the issue (optional, default to open)
* @param labels Comma-separated list of label names. Fetch only issues that have any of these
* labels. Non existent labels are discarded. (optional)
* @param milestones Comma-separated list of milestone names. Fetch only issues that have any of
* these milestones. Non existent milestones are discarded. (optional)
* @param q Search string (optional)
* @param priorityRepoId Repository ID to prioritize in the results (optional)
* @param type Filter by issue type (optional)
* @param since Only show issues updated after the given time (RFC 3339 format) (optional)
* @param before Only show issues updated before the given time (RFC 3339 format) (optional)
* @param assigned Filter issues or pulls assigned to the authenticated user (optional, default to
* false)
* @param created Filter issues or pulls created by the authenticated user (optional, default to
* false)
* @param mentioned Filter issues or pulls mentioning the authenticated user (optional, default to
* false)
* @param reviewRequested Filter pull requests where the authenticated user&#x27;s review was
* requested (optional, default to false)
* @param reviewed Filter pull requests reviewed by the authenticated user (optional, default to
* false)
* @param owner Filter by repository owner (optional)
* @param team Filter by team (requires organization owner parameter) (optional)
* @param page Page number of results to return (1-based) (optional, default to 1)
* @param limit Number of items per page (optional)
* @return Call&lt;List&lt;Issue&gt;&gt;
*/
@GET("repos/issues/search")