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

updates/adds: docs[*], type change: [CustomPropertyValue.CustomPropertyValue_value], adds: Deployment API coverage #33

Merged
merged 1 commit into from
Jan 25, 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
12 changes: 9 additions & 3 deletions src/GitHub/Gists/Item/Comments/CommentsRequestBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class CommentsRequestBuilder : BaseRequestBuilder {
public CommentsRequestBuilder(string rawUrl, IRequestAdapter requestAdapter) : base(requestAdapter, "{+baseurl}/gists/{gist_id}/comments{?per_page*,page*}", rawUrl) {
}
/// <summary>
/// List gist comments
/// Lists the comments on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/comments#list-gist-comments" />
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling requests</param>
Expand All @@ -57,7 +57,7 @@ public class CommentsRequestBuilder : BaseRequestBuilder {
return collectionResult?.ToList();
}
/// <summary>
/// Create a gist comment
/// Creates a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/comments#create-a-gist-comment" />
/// </summary>
/// <param name="body">The request body</param>
Expand All @@ -78,6 +78,9 @@ public class CommentsRequestBuilder : BaseRequestBuilder {
};
return await RequestAdapter.SendAsync<GistComment>(requestInfo, GistComment.CreateFromDiscriminatorValue, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Lists the comments on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
Expand All @@ -91,6 +94,9 @@ public class CommentsRequestBuilder : BaseRequestBuilder {
requestInfo.Headers.TryAdd("Accept", "application/json");
return requestInfo;
}
/// <summary>
/// Creates a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="body">The request body</param>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
Expand All @@ -115,7 +121,7 @@ public class CommentsRequestBuilder : BaseRequestBuilder {
return new CommentsRequestBuilder(rawUrl, RequestAdapter);
}
/// <summary>
/// List gist comments
/// Lists the comments on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
public class CommentsRequestBuilderGetQueryParameters {
/// <summary>The page number of the results to fetch. 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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public class WithComment_ItemRequestBuilder : BaseRequestBuilder {
await RequestAdapter.SendNoContentAsync(requestInfo, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Get a gist comment
/// Gets a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/comments#get-a-gist-comment" />
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling requests</param>
Expand All @@ -68,7 +68,7 @@ public class WithComment_ItemRequestBuilder : BaseRequestBuilder {
return await RequestAdapter.SendAsync<GistComment>(requestInfo, GistComment.CreateFromDiscriminatorValue, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Update a gist comment
/// Updates a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/comments#update-a-gist-comment" />
/// </summary>
/// <param name="body">The request body</param>
Expand Down Expand Up @@ -101,6 +101,9 @@ public class WithComment_ItemRequestBuilder : BaseRequestBuilder {
requestInfo.Headers.TryAdd("Accept", "application/json");
return requestInfo;
}
/// <summary>
/// Gets a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
Expand All @@ -114,6 +117,9 @@ public class WithComment_ItemRequestBuilder : BaseRequestBuilder {
requestInfo.Headers.TryAdd("Accept", "application/json");
return requestInfo;
}
/// <summary>
/// Updates a comment on a gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="body">The request body</param>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
Expand Down
5 changes: 4 additions & 1 deletion src/GitHub/Gists/Item/Item/WithShaItemRequestBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class WithShaItemRequestBuilder : BaseRequestBuilder {
public WithShaItemRequestBuilder(string rawUrl, IRequestAdapter requestAdapter) : base(requestAdapter, "{+baseurl}/gists/{gist_id}/{sha}", rawUrl) {
}
/// <summary>
/// Get a gist revision
/// Gets a specified gist revision.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/gists#get-a-gist-revision" />
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling requests</param>
Expand All @@ -48,6 +48,9 @@ public class WithShaItemRequestBuilder : BaseRequestBuilder {
};
return await RequestAdapter.SendAsync<GistSimple>(requestInfo, GistSimple.CreateFromDiscriminatorValue, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets a specified gist revision.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
Expand Down
9 changes: 6 additions & 3 deletions src/GitHub/Gists/Item/WithGist_ItemRequestBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public class WithGist_ItemRequestBuilder : BaseRequestBuilder {
await RequestAdapter.SendNoContentAsync(requestInfo, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Get a gist
/// Gets a specified gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/gists#get-a-gist" />
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling requests</param>
Expand All @@ -96,7 +96,7 @@ public class WithGist_ItemRequestBuilder : BaseRequestBuilder {
return await RequestAdapter.SendAsync<GistSimple>(requestInfo, GistSimple.CreateFromDiscriminatorValue, errorMapping, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Allows you to update a gist&apos;s description and to update, delete, or rename gist files. Files from the previous version of the gist that aren&apos;t explicitly changed during an edit are unchanged.At least one of `description` or `files` is required.
/// Allows you to update a gist&apos;s description and to update, delete, or rename gist files. Filesfrom the previous version of the gist that aren&apos;t explicitly changed during an editare unchanged.At least one of `description` or `files` is required.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// API method documentation <see href="https://docs.github.com/rest/gists/gists#update-a-gist" />
/// </summary>
/// <param name="body">The request body</param>
Expand Down Expand Up @@ -130,6 +130,9 @@ public class WithGist_ItemRequestBuilder : BaseRequestBuilder {
requestInfo.Headers.TryAdd("Accept", "application/json");
return requestInfo;
}
/// <summary>
/// Gets a specified gist.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
Expand All @@ -144,7 +147,7 @@ public class WithGist_ItemRequestBuilder : BaseRequestBuilder {
return requestInfo;
}
/// <summary>
/// Allows you to update a gist&apos;s description and to update, delete, or rename gist files. Files from the previous version of the gist that aren&apos;t explicitly changed during an edit are unchanged.At least one of `description` or `files` is required.
/// Allows you to update a gist&apos;s description and to update, delete, or rename gist files. Filesfrom the previous version of the gist that aren&apos;t explicitly changed during an editare unchanged.At least one of `description` or `files` is required.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
/// </summary>
/// <param name="body">The request body</param>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class WithNameItemRequestBuilder : BaseRequestBuilder {
public WithNameItemRequestBuilder(string rawUrl, IRequestAdapter requestAdapter) : base(requestAdapter, "{+baseurl}/gitignore/templates/{name}", rawUrl) {
}
/// <summary>
/// The API also allows fetching the source of a single template.Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
/// Get the content of a gitignore template.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
/// API method documentation <see href="https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template" />
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling requests</param>
Expand All @@ -44,7 +44,7 @@ public class WithNameItemRequestBuilder : BaseRequestBuilder {
return await RequestAdapter.SendAsync<GitignoreTemplate>(requestInfo, GitignoreTemplate.CreateFromDiscriminatorValue, default, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// The API also allows fetching the source of a single template.Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
/// Get the content of a gitignore template.This endpoint supports the following custom media types. 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;- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
/// </summary>
/// <param name="requestConfiguration">Configuration for the request such as headers, query parameters, and middleware options.</param>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
Expand Down