Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT: Added/Updated [timeline docs], adds statuses of waiting, requested, and pending to checkrun #53

Merged
merged 2 commits into from Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/GitHub/Feeds/FeedsRequestBuilder.cs
Expand Up @@ -28,7 +28,7 @@ public class FeedsRequestBuilder : BaseRequestBuilder {
public FeedsRequestBuilder(string rawUrl, IRequestAdapter requestAdapter) : base(requestAdapter, "{+baseurl}/feeds", rawUrl) {
}
/// <summary>
/// GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:* **Timeline**: The GitHub global public timeline* **User**: The public timeline for any user, using `uri_template`. For more information, see &quot;[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).&quot;* **Current user public**: The public timeline for the authenticated user* **Current user**: The private timeline for the authenticated user* **Current user actor**: The private timeline for activity created by the authenticated user* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
/// Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.* **Timeline**: The GitHub global public timeline* **User**: The public timeline for any user, using `uri_template`. For more information, see &quot;[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).&quot;* **Current user public**: The public timeline for the authenticated user* **Current user**: The private timeline for the authenticated user* **Current user actor**: The private timeline for activity created by the authenticated user* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see &quot;[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).&quot;**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
/// API method documentation <see href="https://docs.github.com/rest/activity/feeds#get-feeds" />
/// </summary>
/// <returns>A <see cref="Feed"/></returns>
Expand All @@ -45,7 +45,7 @@ public class FeedsRequestBuilder : BaseRequestBuilder {
return await RequestAdapter.SendAsync<Feed>(requestInfo, Feed.CreateFromDiscriminatorValue, default, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:* **Timeline**: The GitHub global public timeline* **User**: The public timeline for any user, using `uri_template`. For more information, see &quot;[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).&quot;* **Current user public**: The public timeline for the authenticated user* **Current user**: The private timeline for the authenticated user* **Current user actor**: The private timeline for activity created by the authenticated user* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
/// Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.* **Timeline**: The GitHub global public timeline* **User**: The public timeline for any user, using `uri_template`. For more information, see &quot;[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).&quot;* **Current user public**: The public timeline for the authenticated user* **Current user**: The private timeline for the authenticated user* **Current user actor**: The private timeline for activity created by the authenticated user* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see &quot;[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).&quot;**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
/// </summary>
/// <returns>A <see cref="RequestInformation"/></returns>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/GitHub/Models/CheckRun.cs
Expand Up @@ -107,7 +107,7 @@ public class CheckRun : IAdditionalDataHolder, IParsable {
#endif
/// <summary>The started_at property</summary>
public DateTimeOffset? StartedAt { get; set; }
/// <summary>The phase of the lifecycle that the check is currently in.</summary>
/// <summary>The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.</summary>
public CheckRun_status? Status { get; set; }
/// <summary>The url property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
Expand Down
8 changes: 7 additions & 1 deletion src/GitHub/Models/CheckRun_status.cs
Expand Up @@ -2,13 +2,19 @@
using System.Runtime.Serialization;
using System;
namespace GitHub.Models {
/// <summary>The phase of the lifecycle that the check is currently in.</summary>
/// <summary>The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.</summary>
public enum CheckRun_status {
[EnumMember(Value = "queued")]
Queued,
[EnumMember(Value = "in_progress")]
In_progress,
[EnumMember(Value = "completed")]
Completed,
[EnumMember(Value = "waiting")]
Waiting,
[EnumMember(Value = "requested")]
Requested,
[EnumMember(Value = "pending")]
Pending,
}
}
2 changes: 1 addition & 1 deletion src/GitHub/Models/CheckSuite.cs
Expand Up @@ -103,7 +103,7 @@ public class CheckSuite : IAdditionalDataHolder, IParsable {
public bool? Rerequestable { get; set; }
/// <summary>The runs_rerequestable property</summary>
public bool? RunsRerequestable { get; set; }
/// <summary>The status property</summary>
/// <summary>The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.</summary>
public CheckSuite_status? Status { get; set; }
/// <summary>The updated_at property</summary>
public DateTimeOffset? UpdatedAt { get; set; }
Expand Down
7 changes: 7 additions & 0 deletions src/GitHub/Models/CheckSuite_status.cs
Expand Up @@ -2,12 +2,19 @@
using System.Runtime.Serialization;
using System;
namespace GitHub.Models {
/// <summary>The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.</summary>
public enum CheckSuite_status {
[EnumMember(Value = "queued")]
Queued,
[EnumMember(Value = "in_progress")]
In_progress,
[EnumMember(Value = "completed")]
Completed,
[EnumMember(Value = "waiting")]
Waiting,
[EnumMember(Value = "requested")]
Requested,
[EnumMember(Value = "pending")]
Pending,
}
}
4 changes: 4 additions & 0 deletions src/GitHub/Models/Job_status.cs
Expand Up @@ -12,5 +12,9 @@ public enum Job_status {
Completed,
[EnumMember(Value = "waiting")]
Waiting,
[EnumMember(Value = "requested")]
Requested,
[EnumMember(Value = "pending")]
Pending,
}
}
Expand Up @@ -136,7 +136,7 @@ public class RunsRequestBuilderGetQueryParameters {
/// <summary>The number of results per page (max 100). For more information, see &quot;[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).&quot;</summary>
[QueryParameter("per_page")]
public int? PerPage { get; set; }
/// <summary>Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.</summary>
/// <summary>Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.</summary>
[QueryParameter("status")]
public GetStatusQueryParameterType? Status { get; set; }
}
Expand Down
Expand Up @@ -127,7 +127,7 @@ public class RunsRequestBuilderGetQueryParameters {
/// <summary>The number of results per page (max 100). For more information, see &quot;[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).&quot;</summary>
[QueryParameter("per_page")]
public int? PerPage { get; set; }
/// <summary>Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.</summary>
/// <summary>Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.</summary>
[QueryParameter("status")]
public GetStatusQueryParameterType? Status { get; set; }
}
Expand Down
6 changes: 3 additions & 3 deletions src/GitHub/Users/Item/Hovercard/HovercardRequestBuilder.cs
Expand Up @@ -28,7 +28,7 @@ public class HovercardRequestBuilder : BaseRequestBuilder {
public HovercardRequestBuilder(string rawUrl, IRequestAdapter requestAdapter) : base(requestAdapter, "{+baseurl}/users/{username}/hovercard{?subject_id*,subject_type*}", rawUrl) {
}
/// <summary>
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:```shell curl -u username:token https://api.github.com/users/octocat/hovercard?subject_type=repository&amp;subject_id=1300192```OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// API method documentation <see href="https://docs.github.com/rest/users/users#get-contextual-information-for-a-user" />
/// </summary>
/// <returns>A <see cref="GitHub.Models.Hovercard"/></returns>
Expand All @@ -51,7 +51,7 @@ public class HovercardRequestBuilder : BaseRequestBuilder {
return await RequestAdapter.SendAsync<GitHub.Models.Hovercard>(requestInfo, GitHub.Models.Hovercard.CreateFromDiscriminatorValue, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:```shell curl -u username:token https://api.github.com/users/octocat/hovercard?subject_type=repository&amp;subject_id=1300192```OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// </summary>
/// <returns>A <see cref="RequestInformation"/></returns>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
Expand All @@ -76,7 +76,7 @@ public class HovercardRequestBuilder : BaseRequestBuilder {
return new HovercardRequestBuilder(rawUrl, RequestAdapter);
}
/// <summary>
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:```shell curl -u username:token https://api.github.com/users/octocat/hovercard?subject_type=repository&amp;subject_id=1300192```OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The `subject_type` and `subject_id` parameters provide context for the person&apos;s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
/// </summary>
public class HovercardRequestBuilderGetQueryParameters {
/// <summary>Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.</summary>
Expand Down
2 changes: 1 addition & 1 deletion src/GitHub/kiota-lock.json
@@ -1,5 +1,5 @@
{
"descriptionHash": "58EC2F160FFD5574242F7A6CA2B7490F71BCCB733BDE83D3C4F45E78BBE173C1F5709707046D57237BB1BB5CAA0BA8DDC233C230D609A2EA76202F3D94F5F1A9",
"descriptionHash": "DA6E75F17989092BF227D8F9183FC5A5F9B42B6C1168C39791EC5B3139F8746ABF842849DA6BA11C182C2EBE67F95FCA9B2A028275F16F6C4453ADFB0EE36A95",
"descriptionLocation": "../../../source-generator/schemas/downloaded.json",
"lockFileVersion": "1.0.0",
"kiotaVersion": "1.12.0",
Expand Down