Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,5 @@ target/

# Ipython Notebook
.ipynb_checkpoints

.DS_Store
48 changes: 24 additions & 24 deletions .openapi-generator-templates/configuration.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ class Configuration:
:param password: Password for HTTP basic authentication.
{{#hasHttpSignatureMethods}}
:param signing_info: Configuration parameters for the HTTP signature security scheme.
Must be an instance of {{{packageName}}}.signing.HttpSigningConfiguration
Must be an instance of {{packageName}}.signing.HttpSigningConfiguration
{{/hasHttpSignatureMethods}}
:param server_index: Index to servers configuration.
:param server_variables: Mapping with string values to replace variables in
Expand Down Expand Up @@ -206,7 +206,7 @@ class Configuration:

Workspace / sandbox scoping example:

conf = {{{packageName}}}.Configuration(
conf = {{packageName}}.Configuration(
api_key='sk_live_...',
workspace_id='ws_abc',
session_id='sb_xyz',
Expand All @@ -224,7 +224,7 @@ conf = {{{packageName}}}.Configuration(

Configure API client with HTTP basic authentication:

conf = {{{packageName}}}.Configuration(
conf = {{packageName}}.Configuration(
username='the-user',
password='the-password',
)
Expand All @@ -243,7 +243,7 @@ conf = {{{packageName}}}.Configuration(
Configure API client with HTTP signature authentication. Use the 'hs2019' signature scheme,
sign the HTTP requests with the RSA-SSA-PSS signature algorithm, and set the expiration time
of the signature to 5 minutes after the signature has been created.
Note you can use the constants defined in the {{{packageName}}}.signing module, and you can
Note you can use the constants defined in the {{packageName}}.signing module, and you can
also specify arbitrary HTTP headers to be included in the HTTP signature, except for the
'Authorization' header, which is used to carry the signature.

Expand All @@ -252,18 +252,18 @@ conf = {{{packageName}}}.Configuration(
load balancers may add/modify/remove headers. Include the HTTP headers that you know
are not going to be modified in transit.

conf = {{{packageName}}}.Configuration(
signing_info = {{{packageName}}}.signing.HttpSigningConfiguration(
conf = {{packageName}}.Configuration(
signing_info = {{packageName}}.signing.HttpSigningConfiguration(
key_id = 'my-key-id',
private_key_path = 'rsa.pem',
signing_scheme = {{{packageName}}}.signing.SCHEME_HS2019,
signing_algorithm = {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS,
signed_headers = [{{{packageName}}}.signing.HEADER_REQUEST_TARGET,
{{{packageName}}}.signing.HEADER_CREATED,
{{{packageName}}}.signing.HEADER_EXPIRES,
{{{packageName}}}.signing.HEADER_HOST,
{{{packageName}}}.signing.HEADER_DATE,
{{{packageName}}}.signing.HEADER_DIGEST,
signing_scheme = {{packageName}}.signing.SCHEME_HS2019,
signing_algorithm = {{packageName}}.signing.ALGORITHM_RSASSA_PSS,
signed_headers = [{{packageName}}.signing.HEADER_REQUEST_TARGET,
{{packageName}}.signing.HEADER_CREATED,
{{packageName}}.signing.HEADER_EXPIRES,
{{packageName}}.signing.HEADER_HOST,
{{packageName}}.signing.HEADER_DATE,
{{packageName}}.signing.HEADER_DIGEST,
'Content-Type',
'User-Agent'
],
Expand Down Expand Up @@ -304,7 +304,7 @@ conf = {{{packageName}}}.Configuration(
) -> None:
"""Constructor
"""
self._base_path = "{{{basePath}}}" if host is None else host
self._base_path = "{{basePath}}" if host is None else host
"""Default Base url
"""
self.server_index = 0 if server_index is None and host is None else server_index
Expand Down Expand Up @@ -438,11 +438,11 @@ conf = {{{packageName}}}.Configuration(
"""Options to pass down to the underlying urllib3 socket
"""

self.datetime_format = "{{{datetimeFormat}}}"
self.datetime_format = "{{datetimeFormat}}"
"""datetime format
"""

self.date_format = "{{{dateFormat}}}"
self.date_format = "{{dateFormat}}"
"""date format
"""

Expand Down Expand Up @@ -694,7 +694,7 @@ conf = {{{packageName}}}.Configuration(
'type': 'bearer',
'in': 'header',
{{#bearerFormat}}
'format': '{{{.}}}',
'format': '{{.}}',
{{/bearerFormat}}
'key': 'Authorization',
'value': 'Bearer ' + self.api_key
Expand Down Expand Up @@ -746,20 +746,20 @@ conf = {{{packageName}}}.Configuration(
return [
{{#servers}}
{
'url': "{{{url}}}",
'description': "{{{description}}}{{^description}}No description provided{{/description}}",
'url': "{{url}}",
'description': "{{description}}{{^description}}No description provided{{/description}}",
{{#variables}}
{{#-first}}
'variables': {
{{/-first}}
'{{{name}}}': {
'description': "{{{description}}}{{^description}}No description provided{{/description}}",
'default_value': "{{{defaultValue}}}",
'{{name}}': {
'description': "{{description}}{{^description}}No description provided{{/description}}",
'default_value': "{{defaultValue}}",
{{#enumValues}}
{{#-first}}
'enum_values': [
{{/-first}}
"{{{.}}}"{{^-last}},{{/-last}}
"{{.}}"{{^-last}},{{/-last}}
{{#-last}}
]
{{/-last}}
Expand Down
1 change: 0 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -289,5 +289,4 @@ requirements.txt
setup.cfg
test-requirements.txt
test/__init__.py
test/test_results_format_query.py
tox.ini
79 changes: 79 additions & 0 deletions docs/WorkspacesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *https://api.hotdata.dev*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /v1/workspaces | Create a workspace
[**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /v1/workspaces/{public_id} | Delete a workspace
[**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /v1/workspaces | List workspaces


Expand Down Expand Up @@ -92,6 +93,84 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_workspace**
> delete_workspace(public_id)

Delete a workspace

Hard-deletes the workspace. Namespace, storage, and catalog deprovisioning runs asynchronously after the row is removed.

### Example

* Bearer Authentication (BearerAuth):

```python
import hotdata
from hotdata.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.hotdata.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = hotdata.Configuration(
host = "https://api.hotdata.dev"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = hotdata.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hotdata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hotdata.WorkspacesApi(api_client)
public_id = 'public_id_example' # str | Public id of the workspace.

try:
# Delete a workspace
api_instance.delete_workspace(public_id)
except Exception as e:
print("Exception when calling WorkspacesApi->delete_workspace: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**public_id** | **str**| Public id of the workspace. |

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Workspace deleted | - |
**401** | Missing or invalid authorization | - |
**403** | Workspace-scoped tokens are not allowed | - |
**404** | Workspace not found, or caller is not a member of its organization | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_workspaces**
> ListWorkspacesResponse list_workspaces(organization_public_id=organization_public_id)

Expand Down
Loading