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

chore: regenerate sdks #75

Merged
merged 8 commits into from
Mar 13, 2025
Merged

chore: regenerate sdks #75

merged 8 commits into from
Mar 13, 2025

Conversation

ChiragAgg5k
Copy link
Member

@ChiragAgg5k ChiragAgg5k commented Feb 27, 2025

What does this PR do?

  1. refactor use tabs instead of spaces.
  2. add encoding of User-Agent and X-Forwarded-User-Agent in prepareRequest.
  3. changes response type from dynamic to string (breaking)

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes.

@@ -9,7 +9,7 @@ class AppwriteException implements Exception {
/// for more information.
final String? type;
final int? code;
final dynamic response;
final String? response;
Copy link
Member Author

Choose a reason for hiding this comment

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

breaking change ^

Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

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

Changes here look good.

Would you also be able to update https://github.com/appwrite/appwrite/blob/1.6.x/docs/sdks/dart/CHANGELOG.md and get it deployed over in this repo?

Comment on lines -8 to -9
/// Get browser icon
///
Copy link
Contributor

Choose a reason for hiding this comment

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

@abnegate why did we remove the 1st line comment from functions in dart?

appwrite/sdk-generator@271f2d1

cc @lohanidamodar

Copy link
Contributor

Choose a reason for hiding this comment

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

@abnegate said:

I think it caused issues when a single route defined multiple SDK methods. It seems redundant since it's always just the method name too.

with title

/**
 * Get account
 *
 * Get the currently authenticated users account
 */
function getAccount()

vs without

/**
 * Get the currently authenticated users account
 */
function getAccount()

Copy link
Contributor

Choose a reason for hiding this comment

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

At least in dart, the first line is supposed to be a one sentence summary.

https://dart.dev/effective-dart/documentation#do-start-doc-comments-with-a-single-sentence-summary

We can move forward with this, but we should see how this impacts the pub.dev API reference (e.g. https://pub.dev/documentation/dart_appwrite/latest/dart_appwrite/Account-class.html).

@christyjacob4 christyjacob4 merged commit 7debaae into main Mar 13, 2025
@christyjacob4 christyjacob4 deleted the dev branch March 13, 2025 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants