Initial suggestions for plugin release

[madhushreeray30]

Thanks @Mr-Destructive for this new plugin. Great work 🎉 !!

I think this plugin is a WIP hence I would like to give some recommendations on the structure built so far. This would help in faster development and ensure we follow our best practices:

• appwrite.spc

  • Could you please update the appwrite.spc file to follow the format of the namecheap plugin
  • We should use secret_key and project_id to authenticate or use the email_id and password
  • We should mention the authentication parameters however commented out and the values should be in the format of the actual values (however incorrect)
  • We also add details to set these parameters via the environment variable

• appwrite*

  • Many columns have missing descriptions and in many, the descriptions are not clear. We should make sure that the description is a meaningful sentence that illuminates the purpose of the column. It should end with a . period. For example The name of the bucket. instead of just Name
  • We should add the standard steampipe column > title that should be a transform of the name column or the id column if the name is not present
  • One suggestion would be to use EqualsQualString instead of EqualsQuals
  • The name of the table functions is incorrect we should keep the plugin name in it and it should be in singular form, for example tableAppwriteBucket instead of tableBuckets
  • Table names should be singular for example appwrite_bucket instead of appwrite_buckets
  • The naming of the list and hydrate functions is incorrect. For example for the table appwrite_bucket they should be as follows:
  • list function > listbuckets
  • hydrate function > gutbucket
  • The descriptions of the following tables are incorrect >
  • appwrite_files
  • appwrite_executions
  • The logger error messages are pointing to incorrect tables and incorrect functions in many places, it would be great if you can once verify it for all the tables. For instance >

    plugin.Logger(ctx).Error("appwrite.documents", "api_error", err)

    should be modified to

    plugin.Logger(ctx).Error("appwrite_document.listDocuments", "api_error", err)

utils.go and connection_config.go

• Do we have a provision for all the authentication types?
  • Using API key and API secret
  • Using email and password
  • Using project ID and API secret
• Are the environment variables correctly named? Should we name it API_KEY_SECRET? (Taking reference from the Appwrite console)

docs/tables*

• One suggestion would be to include important columns in the query output rather than * this improves visibility and makes the query output clean.
• The example queries in the doc look a bit light. Could you please add 3 to 4 more example queries wherever possible?

• Please provide dummy values in the where parameter rather than YOUR_FUNCTION_ID

  docs/index.md

  • It is incomplete, I guess it is still WIP.
  • For reference, we can follow the namecheap plugin

README.md

• We need to update with the social graphics once done
• Use SQL to query account and more from Appwrite. should follow the link to the website
• Also please make sure that the Configuration section is in sync with the changes suggested for the config/appwrite.spc file.
• We should mention how to authenticate using the environment variable (by using the export command). For reference, we can check the namecheap plugin
• The query needs to be updated to use the important columns rather than *
• We should give the query output as well

• CHANGELOG.md

  • We should mention the tables added
  • For instance

    
    ## v0.0.1 [TBD]

  What's new?

  • New tables added
    • appwrite_accounts
    • continue for other tables... (After changing the name of the table we should update this as well)

• A couple of follow-up questions:

  • How are we handling the resource not found errors?
  • Do the APIs support pagination? I did not find any reference to it, but I want to make sure that we have checked that box before releasing it.
  • While working with the APIs did you encounter rate limit errors?
  • Please refer to https://steampipe.io/docs/develop/plugin-release-checklist#data-ingestion for more information

Please let us know if you have questions, happy to help 👍

[Mr-Destructive]

Thanks for reviewing. I am still testing a few endpoints, especially the health-related ones. I have not yet appropriately started documenting the plugin, once I am done with basic testing of all the tables, I shall complete the description and documentation.

I will try to make the changes as soon as possible. Thanks