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

SaladTechnologies · Sep 1, 2024 · 7470c38 · 7470c38
1 parent 01298cd
commit 7470c38
Show file tree

Hide file tree

Showing 18 changed files with 266 additions and 258 deletions.
diff --git a/.manifest.json b/.manifest.json
@@ -1,6 +1,6 @@
 {
   "liblabVersion": "2.1.30",
-  "date": "2024-08-31T20:15:33.205Z",
+  "date": "2024-09-01T16:26:44.380Z",
   "config": {
     "language": "go",
     "apiId": 1094,
@@ -25,15 +25,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"
@@ -57,7 +57,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"
@@ -100,7 +100,7 @@
           }
         ],
         "githubRepoName": "salad-cloud-sdk-python",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "sdkVersion": "0.9.0-alpha.1",
         "targetBranch": "main"
@@ -115,7 +115,7 @@
         },
         "providerVersion": "0.9.0-alpha.1",
         "githubRepoName": "terraform-provider-salad-cloud",
-        "ignoreFiles": ["LICENSE"],
+        "ignoreFiles": [".gitignore", "LICENSE"],
         "liblabVersion": "2",
         "targetBranch": "main"
       },
@@ -137,7 +137,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"
@@ -264,7 +264,7 @@
     "includeWatermark": false,
     "goModuleName": "github.com/saladtechnologies/salad-cloud-sdk-go",
     "githubRepoName": "salad-cloud-sdk-go",
-    "ignoreFiles": ["LICENSE"],
+    "ignoreFiles": [".gitignore", "LICENSE"],
     "targetBranch": "main",
     "deliveryMethod": "zip",
     "hooks": {
@@ -325,7 +325,6 @@
     "internal/unmarshal/to_object.go",
     "internal/unmarshal/to_primitive.go",
     "internal/marshal/from_complex_object.go",
-    ".gitignore",
     "pkg/saladcloudsdkconfig/config.go",
     "internal/configmanager/config_manager.go",
     "pkg/shared/salad_cloud_sdk_response.go",

diff --git a/README.md b/README.md
@@ -100,9 +100,9 @@ The SDK includes several models that represent the data structures used in API r
 | [ContainerGroupInstance](documentation/models/container_group_instance.md)                         | Represents the details of a single container group instance              |
 | [WorkloadErrorList](documentation/models/workload_error_list.md)                                   | Represents a list of workload errors                                     |
 | [QueueList](documentation/models/queue_list.md)                                                    | Represents a list of queues                                              |
-| [CreateQueue](documentation/models/create_queue.md)                                                | Represents a request to create a queue                                   |
-| [Queue](documentation/models/queue.md)                                                             | Represents a queue                                                       |
-| [UpdateQueue](documentation/models/update_queue.md)                                                | Represents a request to update a queue                                   |
+| [CreateQueue](documentation/models/create_queue.md)                                                | Represents a request to create a new queue.                              |
+| [Queue](documentation/models/queue.md)                                                             | Represents a queue.                                                      |
+| [UpdateQueue](documentation/models/update_queue.md)                                                | Represents a request to update an existing queue.                        |
 | [QueueJobList](documentation/models/queue_job_list.md)                                             | Represents a list of queue jobs                                          |
 | [CreateQueueJob](documentation/models/create_queue_job.md)                                         | Represents a request to create a queue job                               |
 | [QueueJob](documentation/models/queue_job.md)                                                      | Represents a queue job                                                   |

diff --git a/documentation/models/create_queue.md b/documentation/models/create_queue.md
@@ -1,11 +1,11 @@
 # CreateQueue
 
-Represents a request to create a queue
+Represents a request to create a new queue.
 
 **Properties**
 
-| Name        | Type   | Required | Description     |
-| :---------- | :----- | :------- | :-------------- |
-| Name        | string | ✅       |                 |
-| DisplayName | string | ❌       |                 |
-| Description | string | ❌       | The description |
+| Name        | Type   | Required | Description                                                                                  |
+| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------- |
+| Name        | string | ✅       | The queue name. This must be unique within the project.                                      |
+| DisplayName | string | ❌       | The display name. This may be used as a more human-readable name.                            |
+| Description | string | ❌       | The description. This may be used as a space for notes or other information about the queue. |
diff --git a/documentation/models/queue.md b/documentation/models/queue.md
@@ -1,15 +1,15 @@
 # Queue
 
-Represents a queue
+Represents a queue.
 
 **Properties**
 
-| Name            | Type                    | Required | Description     |
-| :-------------- | :---------------------- | :------- | :-------------- |
-| Id              | string                  | ✅       |                 |
-| Name            | string                  | ✅       |                 |
-| DisplayName     | string                  | ✅       |                 |
-| ContainerGroups | []shared.ContainerGroup | ✅       |                 |
-| CreateTime      | string                  | ✅       |                 |
-| UpdateTime      | string                  | ✅       |                 |
-| Description     | string                  | ❌       | The description |
+| Name            | Type                    | Required | Description                                                                                   |
+| :-------------- | :---------------------- | :------- | :-------------------------------------------------------------------------------------------- |
+| Id              | string                  | ✅       | The queue identifier. This is automatically generated and assigned when the queue is created. |
+| Name            | string                  | ✅       | The queue name. This must be unique within the project.                                       |
+| DisplayName     | string                  | ✅       | The display name. This may be used as a more human-readable name.                             |
+| ContainerGroups | []shared.ContainerGroup | ✅       |                                                                                               |
+| CreateTime      | string                  | ✅       | The date and time the queue was created.                                                      |
+| UpdateTime      | string                  | ✅       | The date and time the queue was last updated.                                                 |
+| Description     | string                  | ❌       | The description. This may be used as a space for notes or other information about the queue.  |
diff --git a/documentation/models/queue_list.md b/documentation/models/queue_list.md
@@ -4,6 +4,6 @@ Represents a list of queues
 
 **Properties**
 
-| Name  | Type           | Required | Description |
-| :---- | :------------- | :------- | :---------- |
-| Items | []queues.Queue | ✅       |             |
+| Name  | Type           | Required | Description         |
+| :---- | :------------- | :------- | :------------------ |
+| Items | []queues.Queue | ✅       | The list of queues. |
diff --git a/documentation/models/update_queue.md b/documentation/models/update_queue.md
@@ -1,10 +1,10 @@
 # UpdateQueue
 
-Represents a request to update a queue
+Represents a request to update an existing queue.
 
 **Properties**
 
-| Name        | Type   | Required | Description     |
-| :---------- | :----- | :------- | :-------------- |
-| DisplayName | string | ❌       |                 |
-| Description | string | ❌       | The description |
+| Name        | Type   | Required | Description                                                                                  |
+| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------- |
+| DisplayName | string | ❌       | The display name. This may be used as a more human-readable name.                            |
+| Description | string | ❌       | The description. This may be used as a space for notes or other information about the queue. |