ash_api 0.1.6

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# Rust API client for ash_api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 0.1.6
- Package version: 0.1.6
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `ash_api` and add the following to `Cargo.toml` under `[dependencies]`:

```
ash_api = { path = "./ash_api" }
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**add_project_cloud_region**](docs/DefaultApi.md#add_project_cloud_region) | **POST** /projects/{projectIdOrName}/regions | Add a cloud region to the project
*DefaultApi* | [**create_project**](docs/DefaultApi.md#create_project) | **POST** /projects | Creates a new project
*DefaultApi* | [**create_project_resource**](docs/DefaultApi.md#create_project_resource) | **POST** /projects/{projectIdOrName}/resources | Creates a new resource
*DefaultApi* | [**create_secret**](docs/DefaultApi.md#create_secret) | **POST** /secrets | Creates a new secret
*DefaultApi* | [**delete_project_by_id_or_name**](docs/DefaultApi.md#delete_project_by_id_or_name) | **DELETE** /projects/{projectIdOrName} | Deletes a project by ID or name
*DefaultApi* | [**delete_project_resource_by_id_or_name**](docs/DefaultApi.md#delete_project_resource_by_id_or_name) | **DELETE** /projects/{projectIdOrName}/resources/{resourceIdOrName} | Deletes a resource by ID or name
*DefaultApi* | [**delete_secret_by_id_or_name**](docs/DefaultApi.md#delete_secret_by_id_or_name) | **DELETE** /secrets/{secretIdOrName} | Deletes a secret by ID or name
*DefaultApi* | [**get_all_operations**](docs/DefaultApi.md#get_all_operations) | **GET** /operations | Returns all the operations performed by a user
*DefaultApi* | [**get_all_project_cloud_regions**](docs/DefaultApi.md#get_all_project_cloud_regions) | **GET** /projects/{projectIdOrName}/regions | Returns all project cloud regions
*DefaultApi* | [**get_all_project_resources**](docs/DefaultApi.md#get_all_project_resources) | **GET** /projects/{projectIdOrName}/resources | Returns all project resources
*DefaultApi* | [**get_all_projects**](docs/DefaultApi.md#get_all_projects) | **GET** /projects | Returns all projects
*DefaultApi* | [**get_all_secrets**](docs/DefaultApi.md#get_all_secrets) | **GET** /secrets | Returns all the secrets of a user
*DefaultApi* | [**get_available_cloud_regions**](docs/DefaultApi.md#get_available_cloud_regions) | **GET** /regions | Returns available regions for each cloud provider
*DefaultApi* | [**get_operation_by_id**](docs/DefaultApi.md#get_operation_by_id) | **GET** /operations/{operationId} | Returns an operation by ID
*DefaultApi* | [**get_project_by_id_or_name**](docs/DefaultApi.md#get_project_by_id_or_name) | **GET** /projects/{projectIdOrName} | Returns a project by ID or name
*DefaultApi* | [**get_project_cloud_region_by_name**](docs/DefaultApi.md#get_project_cloud_region_by_name) | **GET** /projects/{projectIdOrName}/regions/{regionName} | Returns a project cloud region by name
*DefaultApi* | [**get_project_resource_by_id_or_name**](docs/DefaultApi.md#get_project_resource_by_id_or_name) | **GET** /projects/{projectIdOrName}/resources/{resourceIdOrName} | Returns a project resource by ID or name
*DefaultApi* | [**get_secret_by_id_or_name**](docs/DefaultApi.md#get_secret_by_id_or_name) | **GET** /secrets/{secretIdOrName} | Returns a secret by ID or name
*DefaultApi* | [**remove_project_cloud_region_by_name**](docs/DefaultApi.md#remove_project_cloud_region_by_name) | **DELETE** /projects/{projectIdOrName}/regions/{regionName} | Remove a project cloud region by name
*DefaultApi* | [**restart_project_resource_by_id_or_name**](docs/DefaultApi.md#restart_project_resource_by_id_or_name) | **POST** /projects/{projectIdOrName}/resources/{resourceIdOrName}/restart | Restarts a project resource by ID or name
*DefaultApi* | [**update_project_by_id_or_name**](docs/DefaultApi.md#update_project_by_id_or_name) | **PATCH** /projects/{projectIdOrName} | Updates a project by ID or name
*DefaultApi* | [**update_project_resource_by_id_or_name**](docs/DefaultApi.md#update_project_resource_by_id_or_name) | **PATCH** /projects/{projectIdOrName}/resources/{resourceIdOrName} | Updates a project resource by ID or name
*DefaultApi* | [**update_secret_by_id_or_name**](docs/DefaultApi.md#update_secret_by_id_or_name) | **PATCH** /secrets/{secretIdOrName} | Updates a secret by ID or name


## Documentation For Models

 - [AvalancheNodeResource](docs/AvalancheNodeResource.md)
 - [AvalancheNodeResourceBase](docs/AvalancheNodeResourceBase.md)
 - [AvalancheNodeResourceBaseNodeConfig](docs/AvalancheNodeResourceBaseNodeConfig.md)
 - [AvalancheNodeResourceBaseNodeStatus](docs/AvalancheNodeResourceBaseNodeStatus.md)
 - [AvalancheNodeResourceResponse](docs/AvalancheNodeResourceResponse.md)
 - [AvalancheSubnetResource](docs/AvalancheSubnetResource.md)
 - [AvalancheSubnetResourceBase](docs/AvalancheSubnetResourceBase.md)
 - [AvalancheSubnetResourceBaseSubnetConfig](docs/AvalancheSubnetResourceBaseSubnetConfig.md)
 - [AvalancheSubnetResourceBaseSubnetStatus](docs/AvalancheSubnetResourceBaseSubnetStatus.md)
 - [AvalancheSubnetResourceResponse](docs/AvalancheSubnetResourceResponse.md)
 - [AwsCredentialsSecret](docs/AwsCredentialsSecret.md)
 - [AwsCredentialsSecretBase](docs/AwsCredentialsSecretBase.md)
 - [AwsCredentialsSecretResponse](docs/AwsCredentialsSecretResponse.md)
 - [AzureCredentialsSecret](docs/AzureCredentialsSecret.md)
 - [AzureCredentialsSecretBase](docs/AzureCredentialsSecretBase.md)
 - [AzureCredentialsSecretResponse](docs/AzureCredentialsSecretResponse.md)
 - [BlockscoutResource](docs/BlockscoutResource.md)
 - [BlockscoutResourceBase](docs/BlockscoutResourceBase.md)
 - [BlockscoutResourceBaseBlockscoutConfig](docs/BlockscoutResourceBaseBlockscoutConfig.md)
 - [BlockscoutResourceBaseBlockscoutStatus](docs/BlockscoutResourceBaseBlockscoutStatus.md)
 - [BlockscoutResourceResponse](docs/BlockscoutResourceResponse.md)
 - [CloudProvider](docs/CloudProvider.md)
 - [CloudRegion](docs/CloudRegion.md)
 - [CreateProject400Response](docs/CreateProject400Response.md)
 - [CreateProjectResourceRequest](docs/CreateProjectResourceRequest.md)
 - [CreateSecretRequest](docs/CreateSecretRequest.md)
 - [GenericSecret](docs/GenericSecret.md)
 - [GenericSecretBase](docs/GenericSecretBase.md)
 - [GenericSecretResponse](docs/GenericSecretResponse.md)
 - [GetAllOperations401Response](docs/GetAllOperations401Response.md)
 - [GetAllOperations403Response](docs/GetAllOperations403Response.md)
 - [GetAllProjectResources200ResponseInner](docs/GetAllProjectResources200ResponseInner.md)
 - [GetAllSecrets200ResponseInner](docs/GetAllSecrets200ResponseInner.md)
 - [GetOperationById404Response](docs/GetOperationById404Response.md)
 - [GoogleCredentialsSecret](docs/GoogleCredentialsSecret.md)
 - [GoogleCredentialsSecretBase](docs/GoogleCredentialsSecretBase.md)
 - [GoogleCredentialsSecretResponse](docs/GoogleCredentialsSecretResponse.md)
 - [Network](docs/Network.md)
 - [NewAvalancheNodeResource](docs/NewAvalancheNodeResource.md)
 - [NewAvalancheSubnetResource](docs/NewAvalancheSubnetResource.md)
 - [NewAwsCredentialsSecret](docs/NewAwsCredentialsSecret.md)
 - [NewAzureCredentialsSecret](docs/NewAzureCredentialsSecret.md)
 - [NewBlockscoutResource](docs/NewBlockscoutResource.md)
 - [NewCloudRegion](docs/NewCloudRegion.md)
 - [NewGenericSecret](docs/NewGenericSecret.md)
 - [NewGoogleCredentialsSecret](docs/NewGoogleCredentialsSecret.md)
 - [NewNodeIdSecret](docs/NewNodeIdSecret.md)
 - [NewProject](docs/NewProject.md)
 - [NewResource](docs/NewResource.md)
 - [NewSecret](docs/NewSecret.md)
 - [NewWalletSecret](docs/NewWalletSecret.md)
 - [NodeIdSecret](docs/NodeIdSecret.md)
 - [NodeIdSecretBase](docs/NodeIdSecretBase.md)
 - [NodeIdSecretResponse](docs/NodeIdSecretResponse.md)
 - [Operation](docs/Operation.md)
 - [Project](docs/Project.md)
 - [ProjectSharedResourceConfig](docs/ProjectSharedResourceConfig.md)
 - [Resource](docs/Resource.md)
 - [ResourceType](docs/ResourceType.md)
 - [Secret](docs/Secret.md)
 - [SecretType](docs/SecretType.md)
 - [SharedResourceConfig](docs/SharedResourceConfig.md)
 - [Size](docs/Size.md)
 - [UpdateAvalancheNodeResource](docs/UpdateAvalancheNodeResource.md)
 - [UpdateAvalancheSubnetResource](docs/UpdateAvalancheSubnetResource.md)
 - [UpdateAwsCredentialsSecret](docs/UpdateAwsCredentialsSecret.md)
 - [UpdateAzureCredentialsSecret](docs/UpdateAzureCredentialsSecret.md)
 - [UpdateBlockscoutResource](docs/UpdateBlockscoutResource.md)
 - [UpdateGenericSecret](docs/UpdateGenericSecret.md)
 - [UpdateGoogleCredentialsSecret](docs/UpdateGoogleCredentialsSecret.md)
 - [UpdateNodeIdSecret](docs/UpdateNodeIdSecret.md)
 - [UpdateProject](docs/UpdateProject.md)
 - [UpdateProjectResourceByIdOrNameRequest](docs/UpdateProjectResourceByIdOrNameRequest.md)
 - [UpdateResource](docs/UpdateResource.md)
 - [UpdateSecret](docs/UpdateSecret.md)
 - [UpdateSecretByIdOrNameRequest](docs/UpdateSecretByIdOrNameRequest.md)
 - [UpdateWalletSecret](docs/UpdateWalletSecret.md)
 - [WalletSecret](docs/WalletSecret.md)
 - [WalletSecretBase](docs/WalletSecretBase.md)
 - [WalletSecretResponse](docs/WalletSecretResponse.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

E36 Knots