@appwrite.io/console 1.4.5 → 1.4.7

package/types/services/vcs.d.ts

@@ -6,6 +6,7 @@ export declare class Vcs {
     /**
      * List repositories
      *
+     * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} search
@@ -16,6 +17,7 @@ export declare class Vcs {
     /**
      * Create repository
      *
+     * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *
      * @param {string} installationId
      * @param {string} name
@@ -27,6 +29,7 @@ export declare class Vcs {
     /**
      * Get repository
      *
+     * Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -37,6 +40,8 @@ export declare class Vcs {
     /**
      * List repository branches
      *
+     * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -47,6 +52,8 @@ export declare class Vcs {
     /**
      * Get files and directories of a VCS repository
      *
+     * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -58,6 +65,7 @@ export declare class Vcs {
     /**
      * Detect runtime settings from source code
      *
+     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -69,6 +77,7 @@ export declare class Vcs {
     /**
      * Authorize external deployment
      *
+     * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} repositoryId
@@ -80,6 +89,8 @@ export declare class Vcs {
     /**
      * List installations
      *
+     * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
+
      *
      * @param {string[]} queries
      * @param {string} search
@@ -90,6 +101,7 @@ export declare class Vcs {
     /**
      * Get installation
      *
+     * Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration.
      *
      * @param {string} installationId
      * @throws {AppwriteException}
@@ -99,6 +111,7 @@ export declare class Vcs {
     /**
      * Delete installation
      *
+     * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
      *
      * @param {string} installationId
      * @throws {AppwriteException}