mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
9a3177e385
* add custom properties model and clients * observable * observable tests * add search * error CS8370: 'target-typed object creation' * Error CS8370: 'target-typed object creation' * add patch with body that return status code * fixes for failed ConventionTests * working UnitTests * (de)serialization and model tests * Update Repository.cs
57 lines
3.2 KiB
C#
57 lines
3.2 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Organization Custom Property Values API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See <a href="https://docs.github.com/rest/orgs/custom-properties">Custom Properties API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IOrganizationCustomPropertyValuesClient
|
|
{
|
|
/// <summary>
|
|
/// Get all custom property values for repositories an organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="org">The name of the organization</param>
|
|
Task<IReadOnlyList<OrganizationCustomPropertyValues>> GetAll(string org);
|
|
|
|
/// <summary>
|
|
/// Get all custom property values for repositories an organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="org">The name of the organization</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<OrganizationCustomPropertyValues>> GetAll(string org, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Get all custom property values for repositories an organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="org">The name of the organization</param>
|
|
/// <param name="repositoryQuery">Finds repositories in the organization with a query containing one or more search keywords and qualifiers.</param>
|
|
[ExcludeFromPaginationApiOptionsConventionTest("This API call uses the OrganizationCustomPropertyValuesRequest parameter for pagination")]
|
|
Task<IReadOnlyList<OrganizationCustomPropertyValues>> GetAll(string org, OrganizationCustomPropertyValuesRequest repositoryQuery);
|
|
|
|
/// <summary>
|
|
/// Create new or update existing custom property values for repositories an organization.
|
|
/// Using a value of null for a custom property will remove or 'unset' the property value from the repository.
|
|
/// A maximum of 30 repositories can be updated in a single request.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="org">The name of the organization</param>
|
|
/// <param name="propertyValues">The custom property values to create or update</param>
|
|
Task CreateOrUpdate(string org, UpsertOrganizationCustomPropertyValues propertyValues);
|
|
}
|
|
}
|