eryph-compute 0.1.1

data/lib/eryph/compute/generated/docs/ProjectsApi.md

@@ -0,0 +1,286 @@
+# ComputeClient::ProjectsApi
+
+All URIs are relative to *https://localhost:8000/compute*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**projects_create**](ProjectsApi.md#projects_create) | **POST** /v1/projects | Create a new project |
+| [**projects_delete**](ProjectsApi.md#projects_delete) | **DELETE** /v1/projects/{id} | Delete a project |
+| [**projects_get**](ProjectsApi.md#projects_get) | **GET** /v1/projects/{id} | Get a project |
+| [**projects_list**](ProjectsApi.md#projects_list) | **GET** /v1/projects | List all projects |
+
+
+## projects_create
+
+> <Operation> projects_create(opts)
+
+Create a new project
+
+Create a project
+
+### Examples
+
+```ruby
+require 'time'
+require 'compute_client'
+# setup authorization
+ComputeClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ComputeClient::ProjectsApi.new
+opts = {
+  new_project_request: ComputeClient::NewProjectRequest.new({name: 'name_example'}) # NewProjectRequest | 
+}
+
+begin
+  # Create a new project
+  result = api_instance.projects_create(opts)
+  p result
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_create: #{e}"
+end
+```
+
+#### Using the projects_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Operation>, Integer, Hash)> projects_create_with_http_info(opts)
+
+```ruby
+begin
+  # Create a new project
+  data, status_code, headers = api_instance.projects_create_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Operation>
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **new_project_request** | [**NewProjectRequest**](NewProjectRequest.md) |  | [optional] |
+
+### Return type
+
+[**Operation**](Operation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## projects_delete
+
+> <Operation> projects_delete(id)
+
+Delete a project
+
+Delete a project
+
+### Examples
+
+```ruby
+require 'time'
+require 'compute_client'
+# setup authorization
+ComputeClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ComputeClient::ProjectsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a project
+  result = api_instance.projects_delete(id)
+  p result
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_delete: #{e}"
+end
+```
+
+#### Using the projects_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Operation>, Integer, Hash)> projects_delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete a project
+  data, status_code, headers = api_instance.projects_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Operation>
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Operation**](Operation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## projects_get
+
+> <Project> projects_get(id)
+
+Get a project
+
+Get a project
+
+### Examples
+
+```ruby
+require 'time'
+require 'compute_client'
+# setup authorization
+ComputeClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ComputeClient::ProjectsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a project
+  result = api_instance.projects_get(id)
+  p result
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_get: #{e}"
+end
+```
+
+#### Using the projects_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> projects_get_with_http_info(id)
+
+```ruby
+begin
+  # Get a project
+  data, status_code, headers = api_instance.projects_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## projects_list
+
+> <ProjectList> projects_list
+
+List all projects
+
+List all projects
+
+### Examples
+
+```ruby
+require 'time'
+require 'compute_client'
+# setup authorization
+ComputeClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ComputeClient::ProjectsApi.new
+
+begin
+  # List all projects
+  result = api_instance.projects_list
+  p result
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_list: #{e}"
+end
+```
+
+#### Using the projects_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProjectList>, Integer, Hash)> projects_list_with_http_info
+
+```ruby
+begin
+  # List all projects
+  data, status_code, headers = api_instance.projects_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProjectList>
+rescue ComputeClient::ApiError => e
+  puts "Error when calling ProjectsApi->projects_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ProjectList**](ProjectList.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/lib/eryph/compute/generated/docs/ResourceType.md

@@ -0,0 +1,15 @@
+# ComputeClient::ResourceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::ResourceType.new()
+```
+

data/lib/eryph/compute/generated/docs/StopCatletRequestBody.md

@@ -0,0 +1,18 @@
+# ComputeClient::StopCatletRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | [**CatletStopMode**](CatletStopMode.md) |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::StopCatletRequestBody.new(
+  mode: null
+)
+```
+

data/lib/eryph/compute/generated/docs/TaskReferenceType.md

@@ -0,0 +1,15 @@
+# ComputeClient::TaskReferenceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::TaskReferenceType.new()
+```
+

data/lib/eryph/compute/generated/docs/UpdateCatletRequestBody.md

@@ -0,0 +1,20 @@
+# ComputeClient::UpdateCatletRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **correlation_id** | **String** |  | [optional] |
+| **configuration** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::UpdateCatletRequestBody.new(
+  correlation_id: null,
+  configuration: null
+)
+```
+

data/lib/eryph/compute/generated/docs/UpdateProjectNetworksRequestBody.md

@@ -0,0 +1,20 @@
+# ComputeClient::UpdateProjectNetworksRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **correlation_id** | **String** |  | [optional] |
+| **configuration** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::UpdateProjectNetworksRequestBody.new(
+  correlation_id: null,
+  configuration: null
+)
+```
+

data/lib/eryph/compute/generated/docs/ValidateConfigRequest.md

@@ -0,0 +1,18 @@
+# ComputeClient::ValidateConfigRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configuration** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::ValidateConfigRequest.new(
+  configuration: null
+)
+```
+

data/lib/eryph/compute/generated/docs/ValidationIssue.md

@@ -0,0 +1,20 @@
+# ComputeClient::ValidationIssue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member** | **String** | The JSON path which identifies the member which has the issue.  Can be null when the issue is not related to  a specific member. | [optional] |
+| **message** | **String** | The details of the issue. |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::ValidationIssue.new(
+  member: null,
+  message: null
+)
+```
+

data/lib/eryph/compute/generated/docs/VersionApi.md

@@ -0,0 +1,69 @@
+# ComputeClient::VersionApi
+
+All URIs are relative to *https://localhost:8000/compute*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**version_get**](VersionApi.md#version_get) | **GET** /v1/version | Get the API version |
+
+
+## version_get
+
+> <ApiVersionResponse> version_get
+
+Get the API version
+
+Gets the API version which can be used by clients for compatibility checks. This endpoint was added with eryph v0.3.
+
+### Examples
+
+```ruby
+require 'time'
+require 'compute_client'
+
+api_instance = ComputeClient::VersionApi.new
+
+begin
+  # Get the API version
+  result = api_instance.version_get
+  p result
+rescue ComputeClient::ApiError => e
+  puts "Error when calling VersionApi->version_get: #{e}"
+end
+```
+
+#### Using the version_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiVersionResponse>, Integer, Hash)> version_get_with_http_info
+
+```ruby
+begin
+  # Get the API version
+  data, status_code, headers = api_instance.version_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiVersionResponse>
+rescue ComputeClient::ApiError => e
+  puts "Error when calling VersionApi->version_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiVersionResponse**](ApiVersionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/lib/eryph/compute/generated/docs/VirtualDisk.md

@@ -0,0 +1,42 @@
+# ComputeClient::VirtualDisk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **location** | **String** |  |  |
+| **data_store** | **String** |  |  |
+| **project** | [**Project**](Project.md) |  |  |
+| **environment** | **String** |  |  |
+| **status** | [**DiskStatus**](DiskStatus.md) |  |  |
+| **gene** | [**VirtualDiskGeneInfo**](VirtualDiskGeneInfo.md) |  | [optional] |
+| **path** | **String** | The file system path of the virtual disk. This information  is only available to administrators. | [optional] |
+| **size_bytes** | **Integer** |  | [optional] |
+| **parent_id** | **String** | The ID of the parent disk when this disk is a differential disk. | [optional] |
+| **parent_path** | **String** | The file system path of the virtual disk's parent. This information  is only available to administrators. The ParentPath might be populated  even if the ParentId is missing. In this case, the disk chain is corrupted. | [optional] |
+| **attached_catlets** | [**Array<VirtualDiskAttachedCatlet>**](VirtualDiskAttachedCatlet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::VirtualDisk.new(
+  id: null,
+  name: null,
+  location: null,
+  data_store: null,
+  project: null,
+  environment: null,
+  status: null,
+  gene: null,
+  path: null,
+  size_bytes: null,
+  parent_id: null,
+  parent_path: null,
+  attached_catlets: null
+)
+```
+

data/lib/eryph/compute/generated/docs/VirtualDiskAttachedCatlet.md

@@ -0,0 +1,20 @@
+# ComputeClient::VirtualDiskAttachedCatlet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**CatletDriveType**](CatletDriveType.md) |  |  |
+| **catlet_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::VirtualDiskAttachedCatlet.new(
+  type: null,
+  catlet_id: null
+)
+```
+

data/lib/eryph/compute/generated/docs/VirtualDiskGeneInfo.md

@@ -0,0 +1,22 @@
+# ComputeClient::VirtualDiskGeneInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gene_set** | **String** |  |  |
+| **name** | **String** |  |  |
+| **architecture** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::VirtualDiskGeneInfo.new(
+  gene_set: null,
+  name: null,
+  architecture: null
+)
+```
+

data/lib/eryph/compute/generated/docs/VirtualDiskList.md

@@ -0,0 +1,18 @@
+# ComputeClient::VirtualDiskList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | [**Array<VirtualDisk>**](VirtualDisk.md) |  |  |
+
+## Example
+
+```ruby
+require 'compute_client'
+
+instance = ComputeClient::VirtualDiskList.new(
+  value: null
+)
+```
+