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.

Sign up for GitHub

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

Merge v0.4.5 #584

Merged
merged 7 commits into from
Dec 19, 2024
Merged

Merge v0.4.5 #584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2f33322
Merge pull request #580 from PinguApps/main
pingu2k4 Dec 18, 2024
1b57ff5
Update dependency xunit.runner.visualstudio to v3
renovate[bot] Dec 18, 2024
3859f86
Merge pull request #582 from PinguApps/renovate/major-xunit-dotnet-mo…
pingu2k4 Dec 19, 2024
bb3dfb4
Adjusted proj files to include pdb and xml files in the nugets
pingu2k4 Dec 19, 2024
9d67b62
Fixed xml doc issues
pingu2k4 Dec 19, 2024
858998d
bump version
pingu2k4 Dec 19, 2024
865a4e1
Merge pull request #583 from PinguApps/581-bug-xml-docs-not-present-i…
pingu2k4 Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public interface IAccountClient
/// Get the list of identities for the currently logged in user
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#listIdentities">Appwrite Docs</see></para>
/// </summary>
/// <param name="queries">Array of query strings generated using the Query class provided by the SDK. <see href="https://appwrite.io/docs/queries">Learn more about queries</see>. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: <c>userId</c>, <c>provider</c>, <c>providerUid</c>, <c>providerEmail</c>, <c>providerAccessTokenExpiry</c></param>
/// <param name="request">The request content</param>
/// <returns>The Identities List</returns>
Task<AppwriteResult<IdentitiesList>> ListIdentities(ListIdentitiesRequest request);

Expand All @@ -64,7 +64,7 @@ public interface IAccountClient
/// Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#listLogs">Appwrite Docs</see></para>
/// </summary>
/// <param name="queries">Array of query strings generated using the Query class provided by the SDK. <see href="https://appwrite.io/docs/queries">Learn more about queries</see>. Only supported methods are limit and offset</param>
/// <param name="request">The request content</param>
/// <returns>The Logs List</returns>
Task<AppwriteResult<LogsList>> ListLogs(ListLogsRequest request);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve parameter documentation for 'request' in the ListLogs method. category Documentation

Tell me more ​

The parameter documentation for 'request' in the ListLogs method is quite generic. It would be more helpful to provide a detailed explanation of what 'request' contains, including its structure and any constraints.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.


Expand All @@ -88,7 +88,7 @@ public interface IAccountClient
/// Add an authenticator app to be used as an MFA factor. Verify the authenticator using <see cref="VerifyAuthenticator"/>
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#createMfaAuthenticator">Appwrite Docs</see></para>
/// </summary>
/// <param name="type">Type of authenticator. Must be `totp`</param>
/// <param name="request">The request content</param>
/// <returns>The MfaType</returns>
Task<AppwriteResult<MfaType>> AddAuthenticator(AddAuthenticatorRequest request);

Expand All @@ -97,7 +97,6 @@ public interface IAccountClient
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updateMfaAuthenticator">Appwrite Docs</see></para>
/// </summary>
/// <param name="request">The request content</param>
/// <param name="type">Type of authenticator</param>
/// <returns>The User</returns>
Task<AppwriteResult<User>> VerifyAuthenticator(VerifyAuthenticatorRequest request);

Expand Down Expand Up @@ -180,7 +179,7 @@ public interface IAccountClient
/// Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updatePrefs">Appwrite Docs</see></para>
/// </summary>
/// <param name="preferences">The request content</param>
/// <param name="request">The request content</param>
/// <returns>The user</returns>
Task<AppwriteResult<User>> UpdatePreferences(UpdatePreferencesRequest request);

Expand Down
6 changes: 5 additions & 1 deletion src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
<Copyright>Copyright 2024 (c) Pingu. All rights reserved.</Copyright>

<TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand All @@ -36,7 +38,7 @@
<ItemGroup>
<ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj">
<ReferenceOutputAssembly>true</ReferenceOutputAssembly>
<IncludeAssets>PinguApps.Appwrite.Shared.dll</IncludeAssets>
<IncludeAssets>PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb</IncludeAssets>
</ProjectReference>
</ItemGroup>

Expand All @@ -48,6 +50,8 @@
<Target DependsOnTargets="ResolveReferences" Name="CopyProjectReferencesToPackage">
<ItemGroup>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference'))"/>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.xml'))"/>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.pdb'))"/>
</ItemGroup>
</Target>

Expand Down
1 change: 1 addition & 0 deletions src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
<ItemGroup>
<ProjectReference Include="..\PinguApps.Appwrite.Client\PinguApps.Appwrite.Client.csproj" />
<ProjectReference Include="..\PinguApps.Appwrite.Server\PinguApps.Appwrite.Server.csproj" />
<ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface IAccountClient
Task<AppwriteResult<User>> Create(CreateAccountRequest request);

/// <summary>
/// Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to call <see cref="UpdateEmail(UpdateEmailRequest)"/> or create an OAuth2 session
/// Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to call <see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updateEmail">Update Email on client</see> or create an OAuth2 session
/// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/account#createAnonymousSession">Appwrite Docs</see></para>
/// </summary>
/// <returns>The Session</returns>
Expand Down
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public interface ITeamsClient
/// <summary>
/// <para>Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.</para>
/// <para>You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.</para>
/// <para>Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use <see cref="UpdateTeamMembershipStatus(UpdateTeamMembershipStatusRequest)"/> to allow the user to accept the invitation to the team.</para>
/// <para>Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use <see href="https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus">UpdateTeamMembershipStatus</see> to allow the user to accept the invitation to the team.</para>
/// <para>Please note that to avoid a <see href="https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md">Redirect Attack</see> Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.</para>
/// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/teams#createMembership">Appwrite Docs</see></para>
/// </summary>
Expand Down
6 changes: 5 additions & 1 deletion src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
<Copyright>Copyright 2024 (c) Pingu. All rights reserved.</Copyright>

<TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand All @@ -36,7 +38,7 @@
<ItemGroup>
<ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj">
<ReferenceOutputAssembly>true</ReferenceOutputAssembly>
<IncludeAssets>PinguApps.Appwrite.Shared.dll</IncludeAssets>
<IncludeAssets>PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb</IncludeAssets>
</ProjectReference>
</ItemGroup>

Expand All @@ -48,6 +50,8 @@
<Target DependsOnTargets="ResolveReferences" Name="CopyProjectReferencesToPackage">
<ItemGroup>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference'))"/>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.xml'))"/>
<BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.pdb'))"/>
</ItemGroup>
</Target>

Expand Down
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public AppwriteResult(OneOf<TResult, AppwriteError, InternalError> result)
}

/// <summary>
/// /// The result of making the API call. Can be <see cref="TResult"/>, <see cref="AppwriteError"/> or <see cref="InternalError"/> depending on what happened
/// The result of making the API call. Can be <typeparamref name="TResult"/>, <see cref="AppwriteError"/> or <see cref="InternalError"/> depending on what happened
/// </summary>
public new OneOf<TResult, AppwriteError, InternalError> Result { get; }

Expand Down
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Shared/Constants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
namespace PinguApps.Appwrite.Shared;
public static class Constants
{
public const string Version = "0.4.4";
public const string Version = "0.4.5";
}
3 changes: 3 additions & 0 deletions src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
<TargetFramework>netstandard2.1</TargetFramework>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>

<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Shared/Responses/IdentitiesList.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace PinguApps.Appwrite.Shared.Responses;
/// <summary>
/// An Appwrite Identities List object
/// </summary>
/// <param name="Count">Total number of identities documents that matched your query.</param>
/// <param name="Total">Total number of identities documents that matched your query.</param>
/// <param name="Identities">List of identities. Can be one of: <see cref="IdentityModel"/></param>
public record IdentitiesList(
[property: JsonPropertyName("total")] int Total,
Expand Down
2 changes: 1 addition & 1 deletion src/PinguApps.Appwrite.Shared/Responses/Jwt.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace PinguApps.Appwrite.Shared.Responses;
/// <summary>
/// A JWT response object
/// </summary>
/// <param name="token">JWT encoded string</param>
/// <param name="Token">JWT encoded string</param>
public record Jwt(
[property: JsonPropertyName("jwt")] string Token
);
2 changes: 1 addition & 1 deletion tests/PinguApps.Appwrite.Client.Tests/PinguApps.Appwrite.Client.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
<PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
<PackageReference Include="xunit" Version="2.9.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion tests/PinguApps.Appwrite.Server.Tests/PinguApps.Appwrite.Server.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<PackageReference Include="Moq" Version="4.20.71" />
<PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
<PackageReference Include="xunit" Version="2.9.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion tests/PinguApps.Appwrite.Shared.Tests/PinguApps.Appwrite.Shared.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<PackageReference Include="Moq" Version="4.20.71" />
<PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
<PackageReference Include="xunit" Version="2.9.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
</ItemGroup>

<ItemGroup>
Expand Down
Loading