linode_openapi_client 4.177.1

data/spec/api/object_storage_api_spec.rb

@@ -0,0 +1,351 @@
+=begin
+#Linode API
+
+#[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).
+
+The version of the OpenAPI document: 4.177.1
+Contact: support@linode.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for LinodeOpenapiClient::ObjectStorageApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ObjectStorageApi' do
+  before do
+    # run before each test
+    @api_instance = LinodeOpenapiClient::ObjectStorageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ObjectStorageApi' do
+    it 'should create an instance of ObjectStorageApi' do
+      expect(@api_instance).to be_instance_of(LinodeOpenapiClient::ObjectStorageApi)
+    end
+  end
+
+  # unit tests for delete_object_storage_bucket
+  # Remove an Object Storage bucket
+  # Removes a single bucket.  > 📘 > > - You need to remove all objects from a bucket before you can delete it. While you *can* delete a bucket using the [s3cmd command-line tool](https://www.linode.com/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to use the [S3 API to configure lifecycle policies](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then delete the bucket. > > - The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_object_storage_bucket test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_object_storage_key
+  # Revoke an Object Storage key
+  # Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.  - A successful request triggers an `obj_access_key_delete` event.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage keys-delete 12345     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param key_id The key to look up.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_object_storage_key test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_object_storage_ssl
+  # Delete an Object Storage TLS/SSL certificate
+  # Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage ssl-delete \\   us-east-1 example-bucket     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_object_storage_ssl test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_bucket
+  # Get an Object Storage bucket
+  # Returns a single Object Storage bucket.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageBucket200Response]
+  describe 'get_object_storage_bucket test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_bucket_acl
+  # Get an Object Storage object ACL config
+  # View an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param name The `name` of the object for which to retrieve its Access Control List (ACL). Run the [List Object Storage bucket contents](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content) operation to access all object names in a bucket.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageBucketAcl200Response]
+  describe 'get_object_storage_bucket_acl test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_bucket_content
+  # List Object Storage bucket contents
+  # Returns the contents of a bucket. The contents are paginated using a `marker`, that's the name of the last object on the previous page.  Objects can also be filtered by `prefix` and `delimiter`. See [Filtering and sorting](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) for more information.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :marker The \"marker\" for this request, which can be used to paginate through large buckets. Its value should be the value of the `next_marker` property returned with the last page. Listing bucket contents _does not_ support arbitrary page access. See the `next_marker` property in the responses section for more details.
+  # @option opts [String] :delimiter The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the `/` character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with `prefix` to see object names past the first occurrence of the delimiter.
+  # @option opts [String] :prefix Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with `delimiter` to allow transversal of bucket contents in a manner similar to a filesystem.
+  # @option opts [Integer] :page_size The number of items to return per page.
+  # @return [GetObjectStorageBucketContent200Response]
+  describe 'get_object_storage_bucket_content test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_bucketin_cluster
+  # List Object Storage buckets per region
+  # Returns a list of buckets on your account, in the specified region.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageBucketinCluster200Response]
+  describe 'get_object_storage_bucketin_cluster test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_buckets
+  # List Object Storage buckets
+  # Returns a paginated list of all Object Storage buckets available in your account.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageBuckets200Response]
+  describe 'get_object_storage_buckets test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_cluster
+  # Get a cluster
+  # __Deprecated__ Returns a single Object Storage cluster.  > 📘 > > This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region), instead.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage clusters-view us-east-1     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param cluster_id Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API.  > 📘 > > You can use the applicable `regionId`, for example `us-west`, in place of the `clusterId`, for example, `us-west-1`. Run [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageCluster200Response]
+  describe 'get_object_storage_cluster test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_clusters
+  # List clusters
+  # Returns a paginated list of available Object Storage legacy clusters.  > 📘 > > This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region), instead.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage clusters-list     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageClusters200Response]
+  describe 'get_object_storage_clusters test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_key
+  # Get an Object Storage key
+  # Returns a single Object Storage key provisioned for your account.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage keys-view \\   --keyId 12345     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param key_id The key to look up.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageKey200Response]
+  describe 'get_object_storage_key test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_keys
+  # List Object Storage keys
+  # Returns a paginated list of Object Storage keys for authenticating to the Object Storage S3 API.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage keys-list     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageKeys200Response]
+  describe 'get_object_storage_keys test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_ssl
+  # Get an Object Storage TLS/SSL certificate
+  # Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage ssl-view \\   us-east-1 example-bucket     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageSsl200Response]
+  describe 'get_object_storage_ssl test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_object_storage_transfer
+  # Get Object Storage transfer data
+  # The amount of outbound data transfer used by your account's Object Storage buckets. Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool. See the [Object Storage Overview](https://www.linode.com/docs/products/storage/object-storage/#pricing) guide for details on Object Storage transfer quotas.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @return [GetObjectStorageTransfer200Response]
+  describe 'get_object_storage_transfer test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_cancel_object_storage
+  # Cancel Object Storage
+  # Cancel Object Storage on an Account.  __Warning__. This removes all buckets and their contents from your Account. This data is irretrievable once removed.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage cancel     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'post_cancel_object_storage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_object_storage_bucket
+  # Create an Object Storage bucket
+  # Creates an Object Storage bucket in the specified data center ([region](https://techdocs.akamai.com/linode-api/reference/get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it.  > 📘 > > - Accounts with negative balances can't access this operation. > > - The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) equivalent operation offers more detail. > > - The API still supports the `clusterId` equivalent (`us-west-1`) when setting a `region` for a new bucket, but you should use the `regionId` (`us-west`), instead.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PostObjectStorageBucketRequest] :post_object_storage_bucket_request Information about the bucket you want to create.
+  # @return [PostObjectStorageBucket200Response]
+  describe 'post_object_storage_bucket test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_object_storage_bucket_access
+  # Modify access to an Object Storage bucket
+  # Apply basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings.  > 📘 > > For more fine-grained control of both systems, use the [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl).   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PostObjectStorageBucketAccessRequest] :post_object_storage_bucket_access_request The changes to make to the bucket's access controls.
+  # @return [Object]
+  describe 'post_object_storage_bucket_access test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_object_storage_keys
+  # Create an Object Storage key
+  # Provisions a new Object Storage key for authenticating to the Object Storage S3 API. A successful request triggers an `obj_access_key_create` [event](https://techdocs.akamai.com/linode-api/reference/get-events).  > 📘 > > Accounts with negative balances can't access this operation.  **The `regions` and `region` parameters**  When creating an Object Storage key, specify one or more data centers ([regions](https://techdocs.akamai.com/linode-api/reference/get-regions)) where you want to create and manage Object Storage buckets.  - **The `regions` array**. Populate it with `regionId` values. The resulting Object Storage key grants access to list and create new buckets in these regions. This *doesn't* give access to manage content in these buckets. To address this, you can:    - Use the `bucket_access` array instead to grant management access, per bucket.    - Use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to change the access for this key.  - **The `bucket_access` array**. This optional array lets you set up limited keys. Include individual objects naming a `regionId`, the target `bucket_name`, and the `permissions` for the Object Storage key. Use the resulting key to manage content in the `bucket_name`, based on the permission level set. You can also use the key to create new buckets in the named region. However, the key doesn't have access to manage content in the newly created bucket. You can grant it this access using [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/).  - **Combine the two to apply varying levels of access in the key**. For example, set `regions` to `us-west` to give the key bucket list and create access in that region. Then, set up the `bucket_access` array to give access to a specific `bucket_name` in the `us-east` region. The key has access to manage content in that `bucket_name` and list and create buckets in the `us-east` region, too. If you include the same region in both, the settings applied in the `bucket_access` array take precedence. For example, assume you include `us-east` in the `regions` array, expecting to only give bucket list and creation access to that region. If you also set `us-east` as a `region` in the `bucket_access` array, the Object Storage key gives access to manage content in the specified `bucket_name`, and lets you list and create buckets in that region.  **The `cluster` parameter (legacy)**  For backward compatibility, include the `cluster` parameter to create an Object Storage key. Use the `clusterId` equivalent (us-west-1) instead of the `regionId` (us-west). Leave the `regions` array out. If including the `bucket_access` array to limit access, omit `region` from each object. Use the resulting key in clusters in all supported regions.  > 📘 > > While the API supports this method, you should use the `regions` parameters, instead.  - **Unlimited access**. Omit the `bucket_access` array. The Object Storage key has unlimited cluster access to all buckets, with all permissions.  - **Limited access**. Include the `bucket_access` array. Set the target `bucket_name` and the level of `permissions` for access to that bucket. Use the resulting key to manage content in the named bucket. A limited Object Storage key can [list all buckets](https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) and [create a new bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). However, you can't use the key to perform any actions on a bucket, unless the key has access to it. You can use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to modify a key's access.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage keys-create \\   --label \"my-object-storage-key\" \\   --bucket_access '[{\"region\": \"ap-south\", \"bucket_name\": \"bucket-example-1\", \"permissions\": \"read_write\" }]'     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PostObjectStorageKeysRequest] :post_object_storage_keys_request The settings necessary to create a new key.
+  # @return [PostObjectStorageKeys200Response]
+  describe 'post_object_storage_keys test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_object_storage_object_url
+  # Create a URL for an object
+  # Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body's `method` parameter.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PostObjectStorageObjectUrlRequest] :post_object_storage_object_url_request Information about the request to sign.
+  # @return [PostObjectStorageObjectUrl200Response]
+  describe 'post_object_storage_object_url test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_object_storage_ssl
+  # Upload an Object Storage TLS/SSL certificate
+  # Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest.  To replace an expired certificate, [delete your current certificates](https://techdocs.akamai.com/linode-api/reference/delete-object-storage-ssl) and upload a new one.   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage ssl-upload \\   us-east-1 example-bucket \\   --certificate \"-----BEGIN CERTIFICATE-----                  CERTIFICATE_INFORMATION                  -----END CERTIFICATE-----\" \\   --private_key \"-----BEGIN PRIVATE KEY-----                  PRIVATE_KEY_INFORMATION                  -----END PRIVATE KEY-----\"     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PostObjectStorageSslRequest] :post_object_storage_ssl_request Upload this TLS/SSL certificate with its corresponding secret key.
+  # @return [GetObjectStorageSsl200Response]
+  describe 'post_object_storage_ssl test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_object_storage_bucket_acl
+  # Update an object's ACL config
+  # Update an object's configured access control level (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users.  > 📘 > > The [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) equivalent operation offers more detail.   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PutObjectStorageBucketAclRequest] :put_object_storage_bucket_acl_request The changes to make to this Object's access controls.
+  # @return [PutObjectStorageBucketAcl200Response]
+  describe 'put_object_storage_bucket_acl test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_object_storage_key
+  # Update an Object Storage key
+  # Updates an Object Storage key on your account. A successful request triggers an `obj_access_key_update` [event](https://techdocs.akamai.com/linode-api/reference/get-events).   <<LB>>  ---   - __CLI__.      ```     linode-cli object-storage keys-update \\   --keyId 12345   --label \"my-object-storage-key\"     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param key_id The key to look up.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PutObjectStorageKeyRequest] :put_object_storage_key_request The fields to update.
+  # @return [PutObjectStorageKey200Response]
+  describe 'put_object_storage_key test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_storage_bucket_access
+  # Update access to an Object Storage bucket
+  # Update basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings.  > 📘 > > For more fine-grained control of both systems, use the [S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl).   <<LB>>  ---   - __OAuth scopes__.      ```     object_storage:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param region_id Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
+  # @param bucket The bucket name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PutStorageBucketAccessRequest] :put_storage_bucket_access_request The changes to make to the bucket's access controls.
+  # @return [Object]
+  describe 'put_storage_bucket_access test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/placement_groups_api_spec.rb

@@ -0,0 +1,130 @@
+=begin
+#Linode API
+
+#[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).
+
+The version of the OpenAPI document: 4.177.1
+Contact: support@linode.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for LinodeOpenapiClient::PlacementGroupsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PlacementGroupsApi' do
+  before do
+    # run before each test
+    @api_instance = LinodeOpenapiClient::PlacementGroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PlacementGroupsApi' do
+    it 'should create an instance of PlacementGroupsApi' do
+      expect(@api_instance).to be_instance_of(LinodeOpenapiClient::PlacementGroupsApi)
+    end
+  end
+
+  # unit tests for delete_placement_group
+  # Delete a placement group
+  # Deletes a placement group you have permission to `read_write`.  - Deleting a placement group can't be undone. - All compute instances need to be [removed](https://techdocs.akamai.com/linode-api/reference/post-group-unassign) before you can delete a placement group. - If your placement group is non-compliant, you can't delete it. You need to wait for our help to bring it [compliant](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#non-compliance-precedence).   <<LB>>  ---   - __CLI__.      ```     linode-cli placement delete 528     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param group_id ID of the placement group to look up. Run the [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups) operation and store the `id` for the applicable placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_placement_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_placement_group
+  # Get a placement group
+  # View a specific placement group by ID.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement view 528     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param group_id ID of the placement group to look up. Run the [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups) operation and store the `id` for the applicable placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [GetPlacementGroup200Response]
+  describe 'get_placement_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_placement_groups
+  # List placement groups
+  # Returns a paginated list of placement groups you have permission to view.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement-list     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     placement:read_only     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page The page of a collection to return.
+  # @option opts [Integer] :page_size The number of items to return per page.
+  # @return [GetPlacementGroups200Response]
+  describe 'get_placement_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_group_add_linode
+  # Assign a placement group
+  # Add one or more compute instances to your placement group. Check out our [example API workflow](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#create-a-placement-group) to create a placement group and add compute instances.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement assignLinode 528 \\   --linodes 123 456 \\   --non-compliant true     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param group_id ID of the placement group to look up. Run the [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups) operation and store the `id` for the applicable placement group.
+  # @param post_group_add_linode_request The compute instances you want to add to your placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [PostGroupAddLinode200Response]
+  describe 'post_group_add_linode test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_group_unassign
+  # Unassign a placement group
+  # Remove one or more compute instances from your placement group.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement unassignLinode 528 \\   --linode 123 456     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param group_id ID of the placement group to look up. Run the [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups) operation and store the `id` for the applicable placement group.
+  # @param request_body The compute instances you want to remove from your placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [PostGroupUnassign200Response]
+  describe 'post_group_unassign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_placement_group
+  # Create placement group
+  # Creates a placement group on your account. Placement groups disperse your compute instances across physical machines (hosts) in one of our compute regions. Depending on your workload requirements, you may need your compute instances to follow specific strategies:  - __Grouped together__. You may want them placed close together to reduce latency between compute instances that are used for an application or workload. - __Spread apart__. You may want to disperse them across several hosts to support high availability, for example when required for failover.  <<LB>>  > 📘 > > - Currently, this service is only available in [select regions](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#availability). > - For this request to complete successfully, your user needs to have the `add_placement` grant. > - We offer an [example API workflow](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#create-a-placement-group) you can follow to create a placement group.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement create \\   --label PG_Miami_failover \\   --region us-mia \\   --placement_group_type \"anti-affinity:local\" \\   --placement_group_policy strict     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param post_placement_group_request The requested initial state of the new placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [PostPlacementGroup200Response]
+  describe 'post_placement_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_placement_group
+  # Update a placement group
+  # Change the `label` for a specific placement group. This is the only value you can update. However, you can [add](https://techdocs.akamai.com/linode-api/reference/post-group-add-linode) more compute instances or [remove](https://techdocs.akamai.com/linode-api/reference/post-group-unassign) existing ones.   <<LB>>  ---   - __CLI__.      ```     linode-cli placement update 528 \\   --label PG_Miami_failover_update     ```      [Learn more...](https://www.linode.com/docs/products/tools/cli/get-started/)  - __OAuth scopes__.      ```     linodes:read_write     ```      [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)
+  # @param api_version __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.
+  # @param group_id ID of the placement group to look up. Run the [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups) operation and store the `id` for the applicable placement group.
+  # @param put_placement_group_request Include the `label` parameter to update the name of your placement group.
+  # @param [Hash] opts the optional parameters
+  # @return [PutPlacementGroup200Response]
+  describe 'put_placement_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end