liblab SDK update for version v0.9.0-alpha.1

SaladTechnologies · Sep 1, 2024 · 08b32fc · 08b32fc
1 parent e3e1d99
commit 08b32fc
Show file tree

Hide file tree

Showing 57 changed files with 389 additions and 369 deletions.
diff --git a/.manifest.json b/.manifest.json
@@ -1,6 +1,6 @@
 {
   "liblabVersion": "2.1.30",
-  "date": "2024-08-31T20:15:36.518Z",
+  "date": "2024-09-01T16:26:40.431Z",
   "config": {
     "apiId": 1094,
     "sdkName": "salad-cloud-sdk",
@@ -24,15 +24,15 @@
         ],
         "githubRepoName": "salad-cloud-sdk-dotnet",
         "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-dotnet",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
       },
       "go": {
         "goModuleName": "github.com/saladtechnologies/salad-cloud-sdk-go",
         "githubRepoName": "salad-cloud-sdk-go",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
@@ -56,7 +56,7 @@
         ],
         "githubRepoName": "salad-cloud-sdk-java",
         "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-java",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
@@ -99,7 +99,7 @@
           }
         ],
         "githubRepoName": "salad-cloud-sdk-python",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
@@ -114,7 +114,7 @@
         },
         "providerVersion": "0.9.0-alpha.1",
         "githubRepoName": "terraform-provider-salad-cloud",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "targetBranch": "main"
       },
@@ -136,7 +136,7 @@
         ],
         "githubRepoName": "salad-cloud-sdk-javascript",
         "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-javascript",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
@@ -272,7 +272,7 @@
     ],
     "githubRepoName": "salad-cloud-sdk-dotnet",
     "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-dotnet",
-    "ignoreFiles": ["LICENSE"],
+    "ignoreFiles": [".gitignore", "LICENSE"],
     "targetBranch": "main",
     "language": "csharp",
     "deliveryMethod": "zip",

diff --git a/Example/Program.cs b/Example/Program.cs
@@ -12,6 +12,6 @@
 
 var client = new SaladCloudSdkClient(config);
 
-var response = await client.Quotas.GetQuotasAsync("o110sou");
+var response = await client.Quotas.GetQuotasAsync("y-7yhh5v70xusg163gdfs9vma6wkyd2rcvosdiwny-k");
 
 Console.WriteLine(response);
diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ ApiKeyAuth = apiKeyConfig
 
 var client = new SaladCloudSdkClient(config);
 
-var response = await client.Quotas.GetQuotasAsync("o110sou");
+var response = await client.Quotas.GetQuotasAsync("y-7yhh5v70xusg163gdfs9vma6wkyd2rcvosdiwny-k");
 
 Console.WriteLine(response);
 
@@ -126,9 +126,9 @@ The SDK includes several models that represent the data structures used in API r
 | [ContainerGroupInstance](documentation/models/ContainerGroupInstance.md)                       | Represents the details of a single container group instance              |
 | [WorkloadErrorList](documentation/models/WorkloadErrorList.md)                                 | Represents a list of workload errors                                     |
 | [QueueList](documentation/models/QueueList.md)                                                 | Represents a list of queues                                              |
-| [CreateQueue](documentation/models/CreateQueue.md)                                             | Represents a request to create a queue                                   |
-| [Queue](documentation/models/Queue.md)                                                         | Represents a queue                                                       |
-| [UpdateQueue](documentation/models/UpdateQueue.md)                                             | Represents a request to update a queue                                   |
+| [CreateQueue](documentation/models/CreateQueue.md)                                             | Represents a request to create a new queue.                              |
+| [Queue](documentation/models/Queue.md)                                                         | Represents a queue.                                                      |
+| [UpdateQueue](documentation/models/UpdateQueue.md)                                             | Represents a request to update an existing queue.                        |
 | [QueueJobList](documentation/models/QueueJobList.md)                                           | Represents a list of queue jobs                                          |
 | [CreateQueueJob](documentation/models/CreateQueueJob.md)                                       | Represents a request to create a queue job                               |
 | [QueueJob](documentation/models/QueueJob.md)                                                   | Represents a queue job                                                   |

diff --git a/SaladCloudSdk/Models/CreateQueue.cs b/SaladCloudSdk/Models/CreateQueue.cs
@@ -2,11 +2,15 @@
 
 namespace SaladCloudSdk.Models;
 
-/// <summary>Represents a request to create a queue</summary>
+/// <summary>Represents a request to create a new queue.</summary>
 public record CreateQueue(
-    [property: JsonPropertyName("name")] string Name,
-    [property: JsonPropertyName("display_name")] string? DisplayName = null,
-    /// <value>The description</value>
+    /// <value>The queue name. This must be unique within the project.</value>
+    [property: JsonPropertyName("name")]
+        string Name,
+    /// <value>The display name. This may be used as a more human-readable name.</value>
+    [property: JsonPropertyName("display_name")]
+        string? DisplayName = null,
+    /// <value>The description. This may be used as a space for notes or other information about the queue.</value>
     [property: JsonPropertyName("description")]
         string? Description = null
 );
diff --git a/SaladCloudSdk/Models/Queue.cs b/SaladCloudSdk/Models/Queue.cs
@@ -2,15 +2,25 @@
 
 namespace SaladCloudSdk.Models;
 
-/// <summary>Represents a queue</summary>
+/// <summary>Represents a queue.</summary>
 public record Queue(
-    [property: JsonPropertyName("id")] string Id,
-    [property: JsonPropertyName("name")] string Name,
-    [property: JsonPropertyName("display_name")] string DisplayName,
+    /// <value>The queue identifier. This is automatically generated and assigned when the queue is created.</value>
+    [property: JsonPropertyName("id")]
+        string Id,
+    /// <value>The queue name. This must be unique within the project.</value>
+    [property: JsonPropertyName("name")]
+        string Name,
+    /// <value>The display name. This may be used as a more human-readable name.</value>
+    [property: JsonPropertyName("display_name")]
+        string DisplayName,
     [property: JsonPropertyName("container_groups")] List<ContainerGroup> ContainerGroups,
-    [property: JsonPropertyName("create_time")] string CreateTime,
-    [property: JsonPropertyName("update_time")] string UpdateTime,
-    /// <value>The description</value>
+    /// <value>The date and time the queue was created.</value>
+    [property: JsonPropertyName("create_time")]
+        string CreateTime,
+    /// <value>The date and time the queue was last updated.</value>
+    [property: JsonPropertyName("update_time")]
+        string UpdateTime,
+    /// <value>The description. This may be used as a space for notes or other information about the queue.</value>
     [property: JsonPropertyName("description")]
         string? Description = null
 );
diff --git a/SaladCloudSdk/Models/QueueList.cs b/SaladCloudSdk/Models/QueueList.cs
@@ -3,4 +3,8 @@
 namespace SaladCloudSdk.Models;
 
 /// <summary>Represents a list of queues</summary>
-public record QueueList([property: JsonPropertyName("items")] List<Queue> Items);
+public record QueueList(
+    /// <value>The list of queues.</value>
+    [property: JsonPropertyName("items")]
+        List<Queue> Items
+);
diff --git a/SaladCloudSdk/Models/UpdateQueue.cs b/SaladCloudSdk/Models/UpdateQueue.cs
@@ -2,10 +2,12 @@
 
 namespace SaladCloudSdk.Models;
 
-/// <summary>Represents a request to update a queue</summary>
+/// <summary>Represents a request to update an existing queue.</summary>
 public record UpdateQueue(
-    [property: JsonPropertyName("display_name")] string? DisplayName = null,
-    /// <value>The description</value>
+    /// <value>The display name. This may be used as a more human-readable name.</value>
+    [property: JsonPropertyName("display_name")]
+        string? DisplayName = null,
+    /// <value>The description. This may be used as a space for notes or other information about the queue.</value>
     [property: JsonPropertyName("description")]
         string? Description = null
 );
diff --git a/SaladCloudSdk/Services/ContainerGroupsService.cs b/SaladCloudSdk/Services/ContainerGroupsService.cs
@@ -12,8 +12,8 @@ internal ContainerGroupsService(HttpClient httpClient)
         : base(httpClient) { }
 
     /// <summary>Gets the list of container groups</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     public async Task<ContainerGroupList> ListContainerGroupsAsync(
         string organizationName,
         string projectName,
@@ -45,8 +45,8 @@ public async Task<ContainerGroupList> ListContainerGroupsAsync(
     }
 
     /// <summary>Creates a new container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     public async Task<ContainerGroup> CreateContainerGroupAsync(
         CreateContainerGroup input,
         string organizationName,
@@ -81,8 +81,8 @@ public async Task<ContainerGroup> CreateContainerGroupAsync(
     }
 
     /// <summary>Gets a container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task<ContainerGroup> GetContainerGroupAsync(
         string organizationName,
@@ -118,8 +118,8 @@ public async Task<ContainerGroup> GetContainerGroupAsync(
     }
 
     /// <summary>Updates a container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task<ContainerGroup> UpdateContainerGroupAsync(
         UpdateContainerGroup input,
@@ -162,8 +162,8 @@ public async Task<ContainerGroup> UpdateContainerGroupAsync(
     }
 
     /// <summary>Deletes a container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task DeleteContainerGroupAsync(
         string organizationName,
@@ -192,8 +192,8 @@ public async Task DeleteContainerGroupAsync(
     }
 
     /// <summary>Starts a container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task StartContainerGroupAsync(
         string organizationName,
@@ -222,8 +222,8 @@ public async Task StartContainerGroupAsync(
     }
 
     /// <summary>Stops a container group</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task StopContainerGroupAsync(
         string organizationName,
@@ -252,8 +252,8 @@ public async Task StopContainerGroupAsync(
     }
 
     /// <summary>Retrieves a list of container group instances</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     public async Task<ContainerGroupInstances> ListContainerGroupInstancesAsync(
         string organizationName,
@@ -289,8 +289,8 @@ public async Task<ContainerGroupInstances> ListContainerGroupInstancesAsync(
     }
 
     /// <summary>Retrieves the details of a single instance within a container group by instance ID</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     /// <param name="containerGroupInstanceId">The unique instance identifier</param>
     public async Task<ContainerGroupInstance> GetContainerGroupInstanceAsync(
@@ -333,8 +333,8 @@ public async Task<ContainerGroupInstance> GetContainerGroupInstanceAsync(
     }
 
     /// <summary>Remove a node from a workload and reallocate the workload to a different node</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     /// <param name="containerGroupInstanceId">The unique instance identifier</param>
     public async Task ReallocateContainerGroupInstanceAsync(
@@ -370,8 +370,8 @@ public async Task ReallocateContainerGroupInstanceAsync(
     }
 
     /// <summary>Stops a container, destroys it, creates a new one without requiring the image to be downloaded again on a different node</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     /// <param name="containerGroupInstanceId">The unique instance identifier</param>
     public async Task RecreateContainerGroupInstanceAsync(
@@ -407,8 +407,8 @@ public async Task RecreateContainerGroupInstanceAsync(
     }
 
     /// <summary>Restarts a workload on a node without reallocating it</summary>
-    /// <param name="organizationName">The unique organization name</param>
-    /// <param name="projectName">The unique project name</param>
+    /// <param name="organizationName">Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.</param>
+    /// <param name="projectName">Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.</param>
     /// <param name="containerGroupName">The unique container group name</param>
     /// <param name="containerGroupInstanceId">The unique instance identifier</param>
     public async Task RestartContainerGroupInstanceAsync(