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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
434 changes: 205 additions & 229 deletions README.md

Large diffs are not rendered by default.

18 changes: 8 additions & 10 deletions docs/TokenFields.md → docs/AccessTokenField.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
# TokenFields
# AccessTokenField


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_token** | **str** | | [optional]
**id_token** | **str** | | [optional]
**refresh_token** | **str** | | [optional]

## Example

```python
from hyperstack.models.token_fields import TokenFields
from hyperstack.models.access_token_field import AccessTokenField

# TODO update the JSON string below
json = "{}"
# create an instance of TokenFields from a JSON string
token_fields_instance = TokenFields.from_json(json)
# create an instance of AccessTokenField from a JSON string
access_token_field_instance = AccessTokenField.from_json(json)
# print the JSON string representation of the object
print(TokenFields.to_json())
print(AccessTokenField.to_json())

# convert the object into a dict
token_fields_dict = token_fields_instance.to_dict()
# create an instance of TokenFields from a dict
token_fields_from_dict = TokenFields.from_dict(token_fields_dict)
access_token_field_dict = access_token_field_instance.to_dict()
# create an instance of AccessTokenField from a dict
access_token_field_from_dict = AccessTokenField.from_dict(access_token_field_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
41 changes: 0 additions & 41 deletions docs/AddUpdateFlavorOrganizationPayload.md

This file was deleted.

85 changes: 84 additions & 1 deletion docs/AliveApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@ All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_alive**](AliveApi.md#get_alive) | **GET** /billing/alive | GET: Alive
[**get_doc**](AliveApi.md#get_doc) | **GET** /billing/alive/doc |


# **get_alive**
> get_alive()

GET: Alive

Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](None/docs/api-reference/billing-resources/alive/).

### Example

* Api Key Authentication (apiKey):

```python
import hyperstack
Expand All @@ -26,6 +30,16 @@ configuration = hyperstack.Configuration(
host = "https://infrahub-api.nexgencloud.com/v1"
)

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
Expand All @@ -51,7 +65,76 @@ void (empty response body)

### Authorization

No authorization required
[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |

[[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)

# **get_doc**
> get_doc()



### Example

* Api Key Authentication (apiKey):

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

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
host = "https://infrahub-api.nexgencloud.com/v1"
)

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hyperstack.AliveApi(api_client)

try:
api_instance.get_doc()
except Exception as e:
print("Exception when calling AliveApi->get_doc: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

Expand Down
56 changes: 12 additions & 44 deletions docs/ApiKeyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_api_key**](ApiKeyApi.md#delete_api_key) | **DELETE** /api-key/{api_key_id} | Delete API Key
[**generate_api_key**](ApiKeyApi.md#generate_api_key) | **POST** /api-key/generate | Generate API Key
[**retrieve_api_keys**](ApiKeyApi.md#retrieve_api_keys) | **GET** /api-key | Retrieve API Keys
[**retrieve_api_key**](ApiKeyApi.md#retrieve_api_key) | **GET** /api-key | Retrieve API Keys
[**update_api_key**](ApiKeyApi.md#update_api_key) | **PUT** /api-key/{api_key_id} | Update API Key


Expand All @@ -20,7 +20,6 @@ Delete a specified API key by including the ID of the API key in the path.
### Example

* Api Key Authentication (apiKey):
* Api Key Authentication (accessToken):

```python
import hyperstack
Expand All @@ -45,12 +44,6 @@ configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
# Create an instance of the API class
Expand Down Expand Up @@ -81,7 +74,7 @@ Name | Type | Description | Notes

### Authorization

[apiKey](../README.md#apiKey), [accessToken](../README.md#accessToken)
[apiKey](../README.md#apiKey)

### HTTP request headers

Expand All @@ -105,11 +98,10 @@ Name | Type | Description | Notes

Generate API Key

Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/api-key/generate-api-key).

### Example

* Api Key Authentication (accessToken):

```python
import hyperstack
Expand All @@ -124,16 +116,6 @@ configuration = hyperstack.Configuration(
host = "https://infrahub-api.nexgencloud.com/v1"
)

# 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 API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
Expand Down Expand Up @@ -165,7 +147,7 @@ Name | Type | Description | Notes

### Authorization

[accessToken](../README.md#accessToken)
No authorization required

### HTTP request headers

Expand All @@ -185,17 +167,16 @@ 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)

# **retrieve_api_keys**
> GetApiKeysResponseModel retrieve_api_keys()
# **retrieve_api_key**
> GetApiKeysResponseModel retrieve_api_key()

Retrieve API Keys

Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/api-key/retrieve-api-key).

### Example

* Api Key Authentication (apiKey):
* Api Key Authentication (accessToken):

```python
import hyperstack
Expand All @@ -220,24 +201,18 @@ configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hyperstack.ApiKeyApi(api_client)

try:
# Retrieve API Keys
api_response = api_instance.retrieve_api_keys()
print("The response of ApiKeyApi->retrieve_api_keys:\n")
api_response = api_instance.retrieve_api_key()
print("The response of ApiKeyApi->retrieve_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ApiKeyApi->retrieve_api_keys: %s\n" % e)
print("Exception when calling ApiKeyApi->retrieve_api_key: %s\n" % e)
```


Expand All @@ -252,7 +227,7 @@ This endpoint does not need any parameter.

### Authorization

[apiKey](../README.md#apiKey), [accessToken](../README.md#accessToken)
[apiKey](../README.md#apiKey)

### HTTP request headers

Expand Down Expand Up @@ -280,7 +255,6 @@ Updates the name and optionally the description of a specified API key. Include
### Example

* Api Key Authentication (apiKey):
* Api Key Authentication (accessToken):

```python
import hyperstack
Expand All @@ -306,12 +280,6 @@ configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
# Create an instance of the API class
Expand Down Expand Up @@ -344,7 +312,7 @@ Name | Type | Description | Notes

### Authorization

[apiKey](../README.md#apiKey), [accessToken](../README.md#accessToken)
[apiKey](../README.md#apiKey)

### HTTP request headers

Expand Down
32 changes: 0 additions & 32 deletions docs/ApiKeyVerifyFields.md

This file was deleted.

Loading