From 7470c389eb6e10bf758b8f6fd24a1e96d09e2e45 Mon Sep 17 00:00:00 2001 From: Kyle Dodson Date: Sun, 1 Sep 2024 09:39:48 -0700 Subject: [PATCH] liblab SDK update for version v0.9.0-alpha.1 --- .manifest.json | 17 +- README.md | 6 +- documentation/models/create_queue.md | 12 +- documentation/models/queue.md | 20 +-- documentation/models/queue_list.md | 6 +- documentation/models/update_queue.md | 10 +- .../services/container_groups_service.md | 152 +++++++++--------- .../services/inference_endpoints_service.md | 68 ++++---- .../services/organization_data_service.md | 8 +- documentation/services/queues_service.md | 148 ++++++++--------- documentation/services/quotas_service.md | 8 +- .../services/webhook_secret_key_service.md | 16 +- .../services/workload_errors_service.md | 12 +- pkg/queues/create_queue.go | 8 +- pkg/queues/queue.go | 17 +- pkg/queues/queue_list.go | 1 + pkg/queues/queues_service.go | 10 +- pkg/queues/update_queue.go | 5 +- 18 files changed, 266 insertions(+), 258 deletions(-) diff --git a/.manifest.json b/.manifest.json index 6f200e5..a8272d5 100644 --- 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,7 +25,7 @@ ], "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" @@ -33,7 +33,7 @@ "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 index b4d1b33..701c294 100644 --- 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 index 49f75f8..5c77002 100644 --- 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 index eedee96..0640523 100644 --- 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 index 43e9cab..4e97e1c 100644 --- 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 index e7cd619..3be7b13 100644 --- 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. | diff --git a/documentation/services/container_groups_service.md b/documentation/services/container_groups_service.md index 9f98004..1acbb16 100644 --- a/documentation/services/container_groups_service.md +++ b/documentation/services/container_groups_service.md @@ -26,11 +26,11 @@ Gets the list of container groups **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -66,12 +66,12 @@ Creates a new container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :------------------- | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| createContainerGroup | CreateContainerGroup | ✅ | | +| Name | Type | Required | Description | +| :------------------- | :------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| createContainerGroup | CreateContainerGroup | ✅ | | **Return Type** @@ -127,12 +127,12 @@ Gets a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -168,13 +168,13 @@ Updates a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :------------------- | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | -| updateContainerGroup | UpdateContainerGroup | ✅ | | +| Name | Type | Required | Description | +| :------------------- | :------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| updateContainerGroup | UpdateContainerGroup | ✅ | | **Return Type** @@ -214,12 +214,12 @@ Deletes a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -255,12 +255,12 @@ Starts a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -296,12 +296,12 @@ Stops a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -337,12 +337,12 @@ Retrieves a list of container group instances **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -378,13 +378,13 @@ Retrieves the details of a single instance within a container group by instance **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | -| containerGroupInstanceId | string | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Return Type** @@ -420,13 +420,13 @@ Remove a node from a workload and reallocate the workload to a different node **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | -| containerGroupInstanceId | string | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Return Type** @@ -462,13 +462,13 @@ Stops a container, destroys it, creates a new one without requiring the image to **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | -| containerGroupInstanceId | string | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Return Type** @@ -504,13 +504,13 @@ Restarts a workload on a node without reallocating it **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | -| containerGroupInstanceId | string | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Return Type** diff --git a/documentation/services/inference_endpoints_service.md b/documentation/services/inference_endpoints_service.md index 733800f..6d77f93 100644 --- a/documentation/services/inference_endpoints_service.md +++ b/documentation/services/inference_endpoints_service.md @@ -20,11 +20,11 @@ Gets the list of all inference endpoints **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------------------------------- | :------- | :---------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| params | ListInferenceEndpointsRequestParams | ✅ | Additional request parameters | +| Name | Type | Required | Description | +| :--------------- | :---------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| params | ListInferenceEndpointsRequestParams | ✅ | Additional request parameters | **Return Type** @@ -65,11 +65,11 @@ Gets an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :-------------------- | :------ | :------- | :--------------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| Name | Type | Required | Description | +| :-------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | **Return Type** @@ -105,12 +105,12 @@ Retrieves a list of an inference endpoint jobs **Parameters** -| Name | Type | Required | Description | -| :-------------------- | :------------------------------------ | :------- | :--------------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| inferenceEndpointName | string | ✅ | The unique inference endpoint name | -| params | GetInferenceEndpointJobsRequestParams | ✅ | Additional request parameters | +| Name | Type | Required | Description | +| :-------------------- | :------------------------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| params | GetInferenceEndpointJobsRequestParams | ✅ | Additional request parameters | **Return Type** @@ -151,12 +151,12 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :------------------------- | :------------------------- | :------- | :--------------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| inferenceEndpointName | string | ✅ | The unique inference endpoint name | -| createInferenceEndpointJob | CreateInferenceEndpointJob | ✅ | | +| Name | Type | Required | Description | +| :------------------------- | :------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| createInferenceEndpointJob | CreateInferenceEndpointJob | ✅ | | **Return Type** @@ -197,12 +197,12 @@ Retrieves a job in an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :--------------------- | :------ | :------- | :--------------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| inferenceEndpointName | string | ✅ | The unique inference endpoint name | -| inferenceEndpointJobId | string | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| inferenceEndpointJobId | string | ✅ | The unique job id | **Return Type** @@ -238,12 +238,12 @@ Deletes an inference endpoint job **Parameters** -| Name | Type | Required | Description | -| :--------------------- | :------ | :------- | :--------------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| inferenceEndpointName | string | ✅ | The unique inference endpoint name | -| inferenceEndpointJobId | string | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| inferenceEndpointJobId | string | ✅ | The unique job id | **Return Type** diff --git a/documentation/services/organization_data_service.md b/documentation/services/organization_data_service.md index 47cc465..decec01 100644 --- a/documentation/services/organization_data_service.md +++ b/documentation/services/organization_data_service.md @@ -15,10 +15,10 @@ List the GPU Classes **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | **Return Type** diff --git a/documentation/services/queues_service.md b/documentation/services/queues_service.md index d12467e..4426178 100644 --- a/documentation/services/queues_service.md +++ b/documentation/services/queues_service.md @@ -2,32 +2,32 @@ A list of all methods in the `QueuesService` service. Click on the method name to view detailed information about that method. -| Methods | Description | -| :-------------------------------- | :----------------------------- | -| [ListQueues](#listqueues) | Gets the list of queues | -| [CreateQueue](#createqueue) | Creates a new queue | -| [GetQueue](#getqueue) | Gets a queue | -| [UpdateQueue](#updatequeue) | Updates a queue | -| [DeleteQueue](#deletequeue) | Deletes a queue | -| [ListQueueJobs](#listqueuejobs) | Retrieves a list of queue jobs | -| [CreateQueueJob](#createqueuejob) | Creates a new job | -| [GetQueueJob](#getqueuejob) | Retrieves a job in a queue | -| [DeleteQueueJob](#deletequeuejob) | Deletes a queue job | +| Methods | Description | +| :-------------------------------- | :---------------------------------------------- | +| [ListQueues](#listqueues) | Gets the list of queues in the given project. | +| [CreateQueue](#createqueue) | Creates a new queue in the given project. | +| [GetQueue](#getqueue) | Gets an existing queue in the given project. | +| [UpdateQueue](#updatequeue) | Updates an existing queue in the given project. | +| [DeleteQueue](#deletequeue) | Deletes an existing queue in the given project. | +| [ListQueueJobs](#listqueuejobs) | Retrieves a list of queue jobs | +| [CreateQueueJob](#createqueuejob) | Creates a new job | +| [GetQueueJob](#getqueuejob) | Retrieves a job in a queue | +| [DeleteQueueJob](#deletequeuejob) | Deletes a queue job | ## ListQueues -Gets the list of queues +Gets the list of queues in the given project. - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues` **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -56,19 +56,19 @@ fmt.Print(response) ## CreateQueue -Creates a new queue +Creates a new queue in the given project. - HTTP Method: `POST` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues` **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------- | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| createQueue | CreateQueue | ✅ | | +| Name | Type | Required | Description | +| :--------------- | :---------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| createQueue | CreateQueue | ✅ | | **Return Type** @@ -102,19 +102,19 @@ fmt.Print(response) ## GetQueue -Gets a queue +Gets an existing queue in the given project. - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}` **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Return Type** @@ -143,20 +143,20 @@ fmt.Print(response) ## UpdateQueue -Updates a queue +Updates an existing queue in the given project. - HTTP Method: `PATCH` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}` **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------- | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | -| updateQueue | UpdateQueue | ✅ | | +| Name | Type | Required | Description | +| :--------------- | :---------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| updateQueue | UpdateQueue | ✅ | | **Return Type** @@ -189,19 +189,19 @@ fmt.Print(response) ## DeleteQueue -Deletes a queue +Deletes an existing queue in the given project. - HTTP Method: `DELETE` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}` **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Return Type** @@ -237,13 +237,13 @@ Retrieves a list of queue jobs **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------------------------- | :------- | :---------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | -| params | ListQueueJobsRequestParams | ✅ | Additional request parameters | +| Name | Type | Required | Description | +| :--------------- | :------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| params | ListQueueJobsRequestParams | ✅ | Additional request parameters | **Return Type** @@ -284,13 +284,13 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------------- | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | -| createQueueJob | CreateQueueJob | ✅ | | +| Name | Type | Required | Description | +| :--------------- | :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| createQueueJob | CreateQueueJob | ✅ | | **Return Type** @@ -331,13 +331,13 @@ Retrieves a job in a queue **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | -| queueJobId | string | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| queueJobId | string | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Return Type** @@ -373,13 +373,13 @@ Deletes a queue job **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| queueName | string | ✅ | The unique queue name | -| queueJobId | string | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| queueJobId | string | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Return Type** diff --git a/documentation/services/quotas_service.md b/documentation/services/quotas_service.md index f049c69..e2a8104 100644 --- a/documentation/services/quotas_service.md +++ b/documentation/services/quotas_service.md @@ -15,10 +15,10 @@ Gets the organization quotas **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | **Return Type** diff --git a/documentation/services/webhook_secret_key_service.md b/documentation/services/webhook_secret_key_service.md index 10e925c..f87e6c2 100644 --- a/documentation/services/webhook_secret_key_service.md +++ b/documentation/services/webhook_secret_key_service.md @@ -16,10 +16,10 @@ Gets the webhook secret key **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | **Return Type** @@ -55,10 +55,10 @@ Updates the webhook secret key **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------ | :------- | :--------------------------- | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | +| Name | Type | Required | Description | +| :--------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | **Return Type** diff --git a/documentation/services/workload_errors_service.md b/documentation/services/workload_errors_service.md index 217a99f..0c028ad 100644 --- a/documentation/services/workload_errors_service.md +++ b/documentation/services/workload_errors_service.md @@ -15,12 +15,12 @@ Gets the workload errors **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------ | :------- | :------------------------------ | -| ctx | Context | ✅ | Default go language context | -| organizationName | string | ✅ | The unique organization name | -| projectName | string | ✅ | The unique project name | -| containerGroupName | string | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ctx | Context | ✅ | Default go language context | +| organizationName | string | ✅ | 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. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** diff --git a/pkg/queues/create_queue.go b/pkg/queues/create_queue.go index 3141f56..83526e8 100644 --- a/pkg/queues/create_queue.go +++ b/pkg/queues/create_queue.go @@ -1,10 +1,12 @@ package queues -// Represents a request to create a queue +// Represents a request to create a new queue. type CreateQueue struct { - Name *string `json:"name,omitempty" required:"true" maxLength:"63" minLength:"2" pattern:"^[a-z][a-z0-9-]{0,61}[a-z0-9]$"` + // The queue name. This must be unique within the project. + Name *string `json:"name,omitempty" required:"true" maxLength:"63" minLength:"2" pattern:"^[a-z][a-z0-9-]{0,61}[a-z0-9]$"` + // The display name. This may be used as a more human-readable name. DisplayName *string `json:"display_name,omitempty" maxLength:"63" minLength:"2" pattern:"^[ ,-.0-9A-Za-z]+$"` - // The description + // The description. This may be used as a space for notes or other information about the queue. Description *string `json:"description,omitempty" maxLength:"500"` } diff --git a/pkg/queues/queue.go b/pkg/queues/queue.go index 60ba801..87e2fac 100644 --- a/pkg/queues/queue.go +++ b/pkg/queues/queue.go @@ -4,16 +4,21 @@ import ( "github.com/saladtechnologies/salad-cloud-sdk-go/pkg/shared" ) -// Represents a queue +// Represents a queue. type Queue struct { - Id *string `json:"id,omitempty" required:"true"` - Name *string `json:"name,omitempty" required:"true" maxLength:"63" minLength:"2" pattern:"^[a-z][a-z0-9-]{0,61}[a-z0-9]$"` + // The queue identifier. This is automatically generated and assigned when the queue is created. + Id *string `json:"id,omitempty" required:"true"` + // The queue name. This must be unique within the project. + Name *string `json:"name,omitempty" required:"true" maxLength:"63" minLength:"2" pattern:"^[a-z][a-z0-9-]{0,61}[a-z0-9]$"` + // The display name. This may be used as a more human-readable name. DisplayName *string `json:"display_name,omitempty" required:"true" maxLength:"63" minLength:"2" pattern:"^[ ,-.0-9A-Za-z]+$"` - // The description + // The description. This may be used as a space for notes or other information about the queue. Description *string `json:"description,omitempty" maxLength:"500"` ContainerGroups []shared.ContainerGroup `json:"container_groups,omitempty" required:"true" maxItems:"100"` - CreateTime *string `json:"create_time,omitempty" required:"true"` - UpdateTime *string `json:"update_time,omitempty" required:"true"` + // The date and time the queue was created. + CreateTime *string `json:"create_time,omitempty" required:"true"` + // The date and time the queue was last updated. + UpdateTime *string `json:"update_time,omitempty" required:"true"` } func (q *Queue) SetId(id string) { diff --git a/pkg/queues/queue_list.go b/pkg/queues/queue_list.go index 7600f1f..99db7b6 100644 --- a/pkg/queues/queue_list.go +++ b/pkg/queues/queue_list.go @@ -2,6 +2,7 @@ package queues // Represents a list of queues type QueueList struct { + // The list of queues. Items []Queue `json:"items,omitempty" required:"true" maxItems:"100"` } diff --git a/pkg/queues/queues_service.go b/pkg/queues/queues_service.go index 4087455..db59e75 100644 --- a/pkg/queues/queues_service.go +++ b/pkg/queues/queues_service.go @@ -33,7 +33,7 @@ func (api *QueuesService) SetApiKey(apiKey string) { config.SetApiKey(apiKey) } -// Gets the list of queues +// Gets the list of queues in the given project. func (api *QueuesService) ListQueues(ctx context.Context, organizationName string, projectName string) (*shared.SaladCloudSdkResponse[QueueList], *shared.SaladCloudSdkError) { config := *api.getConfig() @@ -52,7 +52,7 @@ func (api *QueuesService) ListQueues(ctx context.Context, organizationName strin return shared.NewSaladCloudSdkResponse[QueueList](resp), nil } -// Creates a new queue +// Creates a new queue in the given project. func (api *QueuesService) CreateQueue(ctx context.Context, organizationName string, projectName string, createQueue CreateQueue) (*shared.SaladCloudSdkResponse[Queue], *shared.SaladCloudSdkError) { config := *api.getConfig() @@ -73,7 +73,7 @@ func (api *QueuesService) CreateQueue(ctx context.Context, organizationName stri return shared.NewSaladCloudSdkResponse[Queue](resp), nil } -// Gets a queue +// Gets an existing queue in the given project. func (api *QueuesService) GetQueue(ctx context.Context, organizationName string, projectName string, queueName string) (*shared.SaladCloudSdkResponse[Queue], *shared.SaladCloudSdkError) { config := *api.getConfig() @@ -93,7 +93,7 @@ func (api *QueuesService) GetQueue(ctx context.Context, organizationName string, return shared.NewSaladCloudSdkResponse[Queue](resp), nil } -// Updates a queue +// Updates an existing queue in the given project. func (api *QueuesService) UpdateQueue(ctx context.Context, organizationName string, projectName string, queueName string, updateQueue UpdateQueue) (*shared.SaladCloudSdkResponse[Queue], *shared.SaladCloudSdkError) { config := *api.getConfig() @@ -115,7 +115,7 @@ func (api *QueuesService) UpdateQueue(ctx context.Context, organizationName stri return shared.NewSaladCloudSdkResponse[Queue](resp), nil } -// Deletes a queue +// Deletes an existing queue in the given project. func (api *QueuesService) DeleteQueue(ctx context.Context, organizationName string, projectName string, queueName string) (*shared.SaladCloudSdkResponse[any], *shared.SaladCloudSdkError) { config := *api.getConfig() diff --git a/pkg/queues/update_queue.go b/pkg/queues/update_queue.go index 87be0d2..38642e3 100644 --- a/pkg/queues/update_queue.go +++ b/pkg/queues/update_queue.go @@ -1,9 +1,10 @@ package queues -// Represents a request to update a queue +// Represents a request to update an existing queue. type UpdateQueue struct { + // The display name. This may be used as a more human-readable name. DisplayName *string `json:"display_name,omitempty" maxLength:"63" minLength:"2" pattern:"^[ ,-.0-9A-Za-z]+$"` - // The description + // The description. This may be used as a space for notes or other information about the queue. Description *string `json:"description,omitempty" maxLength:"500"` }