Skip to content

Commit

Permalink
[BREAKING CHANGES]: int to long Ids for PreReceiveHook, Deployment En…
Browse files Browse the repository at this point in the history
…vironments, Repository, Org Team, Repo Invitations, Public Key, Project Cards, Organization Invitation, Migrations, GpgKey, Deployment, Authorizations, Accounts / Profiles, Codespace / Workspaces (#2941)

* Fixes ids for Releases, Collaborators, and Contributors

* updates the interface for releases

* update the obverable release client

* updates ids from int to long based on GH database schema

* converts a test condition to use the proper type

* updates generated paging and observable classes
  • Loading branch information
nickfloyd authored Jun 26, 2024
1 parent 16cea25 commit 6565a07
Show file tree
Hide file tree
Showing 84 changed files with 1,293 additions and 1,188 deletions.
1,367 changes: 736 additions & 631 deletions Octokit.AsyncPaginationExtension/Extensions.cs

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public interface IObservableEnterpriseLdapClient
/// <param name="teamId">The teamId to update LDAP mapping</param>
/// <param name="newLdapMapping">The <see cref="NewLdapMapping"/></param>
/// <returns>The <see cref="Team"/> object.</returns>
IObservable<Team> UpdateTeamMapping(int teamId, NewLdapMapping newLdapMapping);
IObservable<Team> UpdateTeamMapping(long teamId, NewLdapMapping newLdapMapping);

/// <summary>
/// Queue an LDAP Sync job for a team on a GitHub Enterprise appliance (must be Site Admin user).
Expand All @@ -53,6 +53,6 @@ public interface IObservableEnterpriseLdapClient
/// </remarks>
/// <param name="teamId">The teamId to update LDAP mapping</param>
/// <returns>The <see cref="LdapSyncResponse"/> of the queue request.</returns>
IObservable<LdapSyncResponse> QueueSyncTeamMapping(int teamId);
IObservable<LdapSyncResponse> QueueSyncTeamMapping(long teamId);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public IObservable<LdapSyncResponse> QueueSyncUserMapping(string userName)
/// <param name="teamId">The teamId to update LDAP mapping</param>
/// <param name="newLdapMapping">The <see cref="NewLdapMapping"/></param>
/// <returns>The <see cref="Team"/> object.</returns>
public IObservable<Team> UpdateTeamMapping(int teamId, NewLdapMapping newLdapMapping)
public IObservable<Team> UpdateTeamMapping(long teamId, NewLdapMapping newLdapMapping)
{
return _client.UpdateTeamMapping(teamId, newLdapMapping).ToObservable();
}
Expand All @@ -71,7 +71,7 @@ public IObservable<Team> UpdateTeamMapping(int teamId, NewLdapMapping newLdapMap
/// </remarks>
/// <param name="teamId">The teamId to update LDAP mapping</param>
/// <returns>The <see cref="LdapSyncResponse"/> of the queue request.</returns>
public IObservable<LdapSyncResponse> QueueSyncTeamMapping(int teamId)
public IObservable<LdapSyncResponse> QueueSyncTeamMapping(long teamId)
{
return _client.QueueSyncTeamMapping(teamId).ToObservable();
}
Expand Down
22 changes: 11 additions & 11 deletions Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface IObservableAuthorizationsClient
/// <returns>An <see cref="Authorization"/></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "It's fiiiine. It's fine. Trust us.")]
IObservable<Authorization> Get(int id);
IObservable<Authorization> Get(long id);

/// <summary>
/// Creates a new personal token for the authenticated user.
Expand Down Expand Up @@ -132,7 +132,7 @@ IObservable<ApplicationAuthorization> Create(
string twoFactorAuthenticationCode);

/// <summary>
/// This method will create a new authorization for the specified OAuth application, only if an authorization
/// This method will create a new authorization for the specified OAuth application, only if an authorization
/// for that application doesn’t already exist for the user. It returns the user’s token for the application
/// if one exists. Otherwise, it creates one.
/// </summary>
Expand All @@ -143,7 +143,7 @@ IObservable<ApplicationAuthorization> Create(
/// <param name="clientId">Client Id for the OAuth application that is requesting the token</param>
/// <param name="clientSecret">The client secret</param>
/// <param name="newAuthorization">Defines the scopes and metadata for the token</param>
/// <exception cref="AuthorizationException">Thrown when the user does not have permission to make
/// <exception cref="AuthorizationException">Thrown when the user does not have permission to make
/// this request. Check </exception>
/// <exception cref="TwoFactorRequiredException">Thrown when the current account has two-factor
/// authentication enabled.</exception>
Expand All @@ -154,19 +154,19 @@ IObservable<ApplicationAuthorization> GetOrCreateApplicationAuthentication(
NewAuthorization newAuthorization);

/// <summary>
/// This method will create a new authorization for the specified OAuth application, only if an authorization
/// This method will create a new authorization for the specified OAuth application, only if an authorization
/// for that application doesn’t already exist for the user. It returns the user’s token for the application
/// if one exists. Otherwise, it creates one.
/// </summary>
/// <remarks>
/// See <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API
/// See <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API
/// documentation</a> for more details.
/// </remarks>
/// <param name="clientId">Client Id for the OAuth application that is requesting the token</param>
/// <param name="clientSecret">The client secret</param>
/// <param name="newAuthorization">Defines the scopes and metadata for the token</param>
/// <param name="twoFactorAuthenticationCode">The two-factor authentication code provided by the user</param>
/// <exception cref="AuthorizationException">Thrown when the user does not have permission to make
/// <exception cref="AuthorizationException">Thrown when the user does not have permission to make
/// this request. Check </exception>
/// <exception cref="TwoFactorChallengeFailedException">Thrown when the two-factor code is not
/// valid.</exception>
Expand Down Expand Up @@ -219,29 +219,29 @@ IObservable<ApplicationAuthorization> GetOrCreateApplicationAuthentication(
/// <param name="id">The id of the <see cref="Authorization"/></param>
/// <param name="authorizationUpdate">The changes to make to the authorization</param>
/// <returns></returns>
IObservable<Authorization> Update(int id, AuthorizationUpdate authorizationUpdate);
IObservable<Authorization> Update(long id, AuthorizationUpdate authorizationUpdate);

/// <summary>
/// Deletes the specified <see cref="Authorization"/>.
/// </summary>
/// <remarks>
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
/// documentation</a> for more details.
/// </remarks>
/// <param name="id">The system-wide Id of the authorization to delete</param>
/// <exception cref="AuthorizationException">
/// Thrown when the current user does not have permission to make the request.
/// </exception>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
IObservable<Unit> Delete(int id);
IObservable<Unit> Delete(long id);

/// <summary>
/// Deletes the specified <see cref="Authorization"/>.
/// </summary>
/// <remarks>
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
/// documentation</a> for more details.
/// </remarks>
/// <param name="id">The system-wide Id of the authorization to delete</param>
Expand All @@ -250,6 +250,6 @@ IObservable<ApplicationAuthorization> GetOrCreateApplicationAuthentication(
/// Thrown when the current user does not have permission to make the request.
/// </exception>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
IObservable<Unit> Delete(int id, string twoFactorAuthenticationCode);
IObservable<Unit> Delete(long id, string twoFactorAuthenticationCode);
}
}
12 changes: 6 additions & 6 deletions Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public interface IObservableDeploymentStatusClient
/// <param name="owner">The owner of the repository.</param>
/// <param name="name">The name of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
IObservable<DeploymentStatus> GetAll(string owner, string name, int deploymentId);
IObservable<DeploymentStatus> GetAll(string owner, string name, long deploymentId);

/// <summary>
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
Expand All @@ -32,7 +32,7 @@ public interface IObservableDeploymentStatusClient
/// </remarks>
/// <param name="repositoryId">The Id of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
IObservable<DeploymentStatus> GetAll(long repositoryId, int deploymentId);
IObservable<DeploymentStatus> GetAll(long repositoryId, long deploymentId);

/// <summary>
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
Expand All @@ -45,7 +45,7 @@ public interface IObservableDeploymentStatusClient
/// <param name="name">The name of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
/// <param name="options">Options for changing the API response</param>
IObservable<DeploymentStatus> GetAll(string owner, string name, int deploymentId, ApiOptions options);
IObservable<DeploymentStatus> GetAll(string owner, string name, long deploymentId, ApiOptions options);

/// <summary>
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
Expand All @@ -57,7 +57,7 @@ public interface IObservableDeploymentStatusClient
/// <param name="repositoryId">The Id of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
/// <param name="options">Options for changing the API response</param>
IObservable<DeploymentStatus> GetAll(long repositoryId, int deploymentId, ApiOptions options);
IObservable<DeploymentStatus> GetAll(long repositoryId, long deploymentId, ApiOptions options);

/// <summary>
/// Creates a new status for the given deployment. Users with push access can create deployment
Expand All @@ -70,7 +70,7 @@ public interface IObservableDeploymentStatusClient
/// <param name="name">The name of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
/// <param name="newDeploymentStatus">The new deployment status to create.</param>
IObservable<DeploymentStatus> Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus);
IObservable<DeploymentStatus> Create(string owner, string name, long deploymentId, NewDeploymentStatus newDeploymentStatus);

/// <summary>
/// Creates a new status for the given deployment. Users with push access can create deployment
Expand All @@ -82,6 +82,6 @@ public interface IObservableDeploymentStatusClient
/// <param name="repositoryId">The Id of the repository.</param>
/// <param name="deploymentId">The id of the deployment.</param>
/// <param name="newDeploymentStatus">The new deployment status to create.</param>
IObservable<DeploymentStatus> Create(long repositoryId, int deploymentId, NewDeploymentStatus newDeploymentStatus);
IObservable<DeploymentStatus> Create(long repositoryId, long deploymentId, NewDeploymentStatus newDeploymentStatus);
}
}
10 changes: 5 additions & 5 deletions Octokit.Reactive/Clients/IObservableMigrationsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public interface IObservableMigrationsClient
/// https://developer.github.com/v3/migration/migrations/#start-a-migration
/// </remarks>
/// <param name="org">The organization for which to start a migration.</param>
/// <param name="migration">Specifies parameters for the migration in a
/// <param name="migration">Specifies parameters for the migration in a
/// <see cref="StartMigrationRequest"/> object.</param>
/// <returns>The started migration.</returns>
IObservable<Migration> Start(
Expand Down Expand Up @@ -64,7 +64,7 @@ IObservable<Migration> GetAll(
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
IObservable<Migration> Get(
string org,
int id);
long id);

/// <summary>
/// Get the migration archive.
Expand All @@ -77,7 +77,7 @@ IObservable<Migration> Get(
/// <returns>The binary contents of the archive as a byte array.</returns>
IObservable<byte[]> GetArchive(
string org,
int id);
long id);

/// <summary>
/// Deletes a previous migration archive.
Expand All @@ -90,7 +90,7 @@ IObservable<byte[]> GetArchive(
/// <returns></returns>
IObservable<Unit> DeleteArchive(
string org,
int id);
long id);

/// <summary>
/// Unlocks a repository that was locked for migration.
Expand All @@ -104,7 +104,7 @@ IObservable<Unit> DeleteArchive(
/// <returns></returns>
IObservable<Unit> UnlockRepository(
string org,
int id,
long id,
string repo);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ public interface IObservableOrganizationMembersClient
/// details of the organization invitation</param>
/// <returns></returns>
IObservable<OrganizationMembershipInvitation> CreateOrganizationInvitation(string org, OrganizationInvitationRequest invitationRequest);

/// <summary>
/// Remove a user's membership with an organization.
/// </summary>
Expand Down Expand Up @@ -389,7 +389,7 @@ public interface IObservableOrganizationMembersClient
/// <param name="org">The login for the organization</param>
/// <param name="invitationId">The unique identifier of the invitation</param>
/// <returns></returns>
IObservable<Unit> CancelOrganizationInvitation(string org, int invitationId);
IObservable<Unit> CancelOrganizationInvitation(string org, long invitationId);

/// <summary>
/// Returns all <see cref="OrganizationMembership" />s for the current user.
Expand Down
8 changes: 4 additions & 4 deletions Octokit.Reactive/Clients/IObservableProjectCardsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public interface IObservableProjectCardsClient
/// </remarks>
/// <param name="id">The id of the card</param>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
IObservable<ProjectCard> Get(int id);
IObservable<ProjectCard> Get(long id);

/// <summary>
/// Creates a card.
Expand All @@ -79,7 +79,7 @@ public interface IObservableProjectCardsClient
/// </remarks>
/// <param name="id">The id of the card</param>
/// <param name="projectCardUpdate">New values to update the card with</param>
IObservable<ProjectCard> Update(int id, ProjectCardUpdate projectCardUpdate);
IObservable<ProjectCard> Update(long id, ProjectCardUpdate projectCardUpdate);

/// <summary>
/// Deletes a card.
Expand All @@ -88,7 +88,7 @@ public interface IObservableProjectCardsClient
/// See the <a href="https://developer.github.com/v3/repos/projects/#delete-a-project-card">API documentation</a> for more information.
/// </remarks>
/// <param name="id">The id of the card</param>
IObservable<bool> Delete(int id);
IObservable<bool> Delete(long id);

/// <summary>
/// Moves a card.
Expand All @@ -98,6 +98,6 @@ public interface IObservableProjectCardsClient
/// </remarks>
/// <param name="id">The id of the card</param>
/// <param name="position">The position to move the card</param>
IObservable<bool> Move(int id, ProjectCardMove position);
IObservable<bool> Move(long id, ProjectCardMove position);
}
}
Loading

0 comments on commit 6565a07

Please sign in to comment.