Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rel1.7 changes #54

Merged
merged 14 commits into from
Jul 18, 2024
2 changes: 1 addition & 1 deletion .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.0.46
3.0.54
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Class | Method | HTTP request | Description
*ResourcesApi* | [**portalresources_get**](docs/ResourcesApi.md#portalresources_get) | **GET** /portalresources | Retrieve a listing and description of available resources for portal
*ResourcesApi* | [**resources_get**](docs/ResourcesApi.md#resources_get) | **GET** /resources | Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.
*SlicesApi* | [**slices_create_post**](docs/SlicesApi.md#slices_create_post) | **POST** /slices/create | Create slice
*SlicesApi* | [**slices_creates_post**](docs/SlicesApi.md#slices_creates_post) | **POST** /slices/creates | Create slice
*SlicesApi* | [**slices_delete_delete**](docs/SlicesApi.md#slices_delete_delete) | **DELETE** /slices/delete | Delete all slices for a User within a project.
*SlicesApi* | [**slices_delete_slice_id_delete**](docs/SlicesApi.md#slices_delete_slice_id_delete) | **DELETE** /slices/delete/{slice_id} | Delete slice.
*SlicesApi* | [**slices_get**](docs/SlicesApi.md#slices_get) | **GET** /slices | Retrieve a listing of user slices
Expand All @@ -128,6 +129,7 @@ Class | Method | HTTP request | Description
- [PoaData](docs/PoaData.md)
- [PoaPost](docs/PoaPost.md)
- [PoaPostData](docs/PoaPostData.md)
- [PoaPostDataKeys](docs/PoaPostDataKeys.md)
- [PoaPostDataVcpuCpuMap](docs/PoaPostDataVcpuCpuMap.md)
- [Resource](docs/Resource.md)
- [Resources](docs/Resources.md)
Expand Down
9 changes: 9 additions & 0 deletions docs/Metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Metrics

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | **list[object]** | | [optional]

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

56 changes: 56 additions & 0 deletions docs/MetricsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# swagger_client.MetricsApi

All URIs are relative to *http://127.0.0.1:8700/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**metrics_overview_get**](MetricsApi.md#metrics_overview_get) | **GET** /metrics/overview | Control Framework metrics overview

# **metrics_overview_get**
> Metrics metrics_overview_get(excluded_projects=excluded_projects)

Control Framework metrics overview

Control Framework metrics overview

### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MetricsApi()
excluded_projects = ['excluded_projects_example'] # list[str] | List of projects to exclude from the metrics overview (optional)

try:
# Control Framework metrics overview
api_response = api_instance.metrics_overview_get(excluded_projects=excluded_projects)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetricsApi->metrics_overview_get: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**excluded_projects** | [**list[str]**](str.md)| List of projects to exclude from the metrics overview | [optional]

### Return type

[**Metrics**](Metrics.md)

### Authorization

No authorization required

### HTTP request headers

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

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

28 changes: 24 additions & 4 deletions docs/ResourcesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Method | HTTP request | Description
[**resources_get**](ResourcesApi.md#resources_get) | **GET** /resources | Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.

# **portalresources_get**
> Resources portalresources_get(graph_format)
> Resources portalresources_get(graph_format, level=level, force_refresh=force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)

Retrieve a listing and description of available resources for portal

Expand All @@ -25,10 +25,16 @@ from pprint import pprint
# create an instance of the API class
api_instance = ResourcesApi()
graph_format = 'GRAPHML' # str | graph format (default to GRAPHML)
level = 1 # int | Level of details (optional) (default to 1)
force_refresh = false # bool | Force to retrieve current available resource information. (optional) (default to false)
start_date = 'start_date_example' # str | starting date to check availability from (optional)
end_date = 'end_date_example' # str | end date to check availability until (optional)
includes = 'includes_example' # str | comma separated lists of sites to include (optional)
excludes = 'excludes_example' # str | comma separated lists of sites to exclude (optional)

try:
# Retrieve a listing and description of available resources for portal
api_response = api_instance.portalresources_get(graph_format)
api_response = api_instance.portalresources_get(graph_format, level=level, force_refresh=force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)
pprint(api_response)
except ApiException as e:
print("Exception when calling ResourcesApi->portalresources_get: %s\n" % e)
Expand All @@ -39,6 +45,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**graph_format** | **str**| graph format | [default to GRAPHML]
**level** | **int**| Level of details | [optional] [default to 1]
**force_refresh** | **bool**| Force to retrieve current available resource information. | [optional] [default to false]
**start_date** | **str**| starting date to check availability from | [optional]
**end_date** | **str**| end date to check availability until | [optional]
**includes** | **str**| comma separated lists of sites to include | [optional]
**excludes** | **str**| comma separated lists of sites to exclude | [optional]

### Return type

Expand All @@ -56,7 +68,7 @@ No authorization required
[[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)

# **resources_get**
> Resources resources_get(level, force_refresh)
> Resources resources_get(level, force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)

Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.

Expand All @@ -80,10 +92,14 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
api_instance = ResourcesApi(ApiClient(configuration))
level = 1 # int | Level of details (default to 1)
force_refresh = False # bool | Force to retrieve current available resource information. (default to false)
start_date = 'start_date_example' # str | starting date to check availability from (optional)
end_date = 'end_date_example' # str | end date to check availability until (optional)
includes = 'includes_example' # str | comma separated lists of sites to include (optional)
excludes = 'excludes_example' # str | comma separated lists of sites to exclude (optional)

try:
# Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.
api_response = api_instance.resources_get(level, force_refresh)
api_response = api_instance.resources_get(level, force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)
pprint(api_response)
except ApiException as e:
print("Exception when calling ResourcesApi->resources_get: %s\n" % e)
Expand All @@ -95,6 +111,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**level** | **int**| Level of details | [default to 1]
**force_refresh** | **bool**| Force to retrieve current available resource information. | [default to false]
**start_date** | **str**| starting date to check availability from | [optional]
**end_date** | **str**| end date to check availability until | [optional]
**includes** | **str**| comma separated lists of sites to include | [optional]
**excludes** | **str**| comma separated lists of sites to exclude | [optional]

### Return type

Expand Down
18 changes: 12 additions & 6 deletions docs/SlicesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ Name | Type | Description | Notes

### HTTP request headers

- **Content-Type**: text/plain
- **Content-Type**: application/json
- **Accept**: application/json

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

# **slices_creates_post**
> Slivers slices_creates_post(body, name, lease_end_time=lease_end_time)
> Slivers slices_creates_post(body, name, lease_start_time=lease_start_time, lease_end_time=lease_end_time)

Create slice

Expand All @@ -101,11 +101,12 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
api_instance = SlicesApi(ApiClient(configuration))
body = SlicesPost() # SlicesPost | Create new Slice
name = 'name_example' # str | Slice Name
lease_start_time = 'lease_start_time_example' # str | Lease End Time for the Slice (optional)
lease_end_time = 'lease_end_time_example' # str | Lease End Time for the Slice (optional)

try:
# Create slice
api_response = api_instance.slices_creates_post(body, name, lease_end_time=lease_end_time)
api_response = api_instance.slices_creates_post(body, name, lease_start_time=lease_start_time, lease_end_time=lease_end_time)
pprint(api_response)
except ApiException as e:
print("Exception when calling SlicesApi->slices_creates_post: %s\n" % e)
Expand All @@ -117,6 +118,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SlicesPost**](SlicesPost.md)| Create new Slice |
**name** | **str**| Slice Name |
**lease_start_time** | **str**| Lease End Time for the Slice | [optional]
**lease_end_time** | **str**| Lease End Time for the Slice | [optional]

### Return type
Expand Down Expand Up @@ -240,7 +242,7 @@ 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)

# **slices_get**
> Slices slices_get(name=name, as_self=as_self, states=states, limit=limit, offset=offset)
> Slices slices_get(name=name, search=search, exact_match=exact_match, as_self=as_self, states=states, limit=limit, offset=offset)

Retrieve a listing of user slices

Expand All @@ -263,14 +265,16 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = SlicesApi(ApiClient(configuration))
name = 'name_example' # str | Search for Slices with the name (optional)
search = 'search_example' # str | search term applied (optional)
exact_match = false # bool | Exact Match for Search term (optional) (default to false)
as_self = true # bool | GET object as Self (optional) (default to true)
states = ['states_example'] # list[str] | Search for Slices in the specified states (optional)
limit = 5 # int | maximum number of results to return per page (1 or more) (optional) (default to 5)
offset = 0 # int | number of items to skip before starting to collect the result set (optional) (default to 0)

try:
# Retrieve a listing of user slices
api_response = api_instance.slices_get(name=name, as_self=as_self, states=states, limit=limit, offset=offset)
api_response = api_instance.slices_get(name=name, search=search, exact_match=exact_match, as_self=as_self, states=states, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling SlicesApi->slices_get: %s\n" % e)
Expand All @@ -281,6 +285,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| Search for Slices with the name | [optional]
**search** | **str**| search term applied | [optional]
**exact_match** | **bool**| Exact Match for Search term | [optional] [default to false]
**as_self** | **bool**| GET object as Self | [optional] [default to true]
**states** | [**list[str]**](str.md)| Search for Slices in the specified states | [optional]
**limit** | **int**| maximum number of results to return per page (1 or more) | [optional] [default to 5]
Expand Down Expand Up @@ -394,7 +400,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**str**](str.md)| | Modify a Slice
**body** | [**str**](str.md)| Modify a Slice |
**slice_id** | **str**| Slice identified by universally unique identifier |

### Return type
Expand Down
Binary file added fabric_cf/.DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion fabric_cf/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.6.0"
__version__ = "1.7.0"
Loading