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

Update Swagger.json (12919134635) #301

Merged
merged 2 commits into from
Jan 23, 2025
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: 1 addition & 1 deletion ansys-grantami-serverapi-openapi/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry]
name = "ansys-grantami-serverapi-openapi"
description = "Autogenerated client library for the Granta MI Server API."
version = "5.0.0.dev398"
version = "5.0.0.dev400"
license = "MIT"
authors = ["ANSYS, Inc. <[email protected]>"]
maintainers = ["ANSYS, Inc. <[email protected]>"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
"""

# import apis into sdk package
from .api.access_control_api import AccessControlApi
from .api.aggregation_api import AggregationApi
from .api.data_api import DataApi
from .api.data_export_api import DataExportApi
Expand All @@ -47,6 +46,7 @@
from .api.list_management_api import ListManagementApi
from .api.list_permissions_api import ListPermissionsApi
from .api.metrics_api import MetricsApi
from .api.permission_based_access_control_api import PermissionBasedAccessControlApi
from .api.records___record_histories_api import RecordsRecordHistoriesApi
from .api.records___record_versions_api import RecordsRecordVersionsApi
from .api.schema___attributes_api import SchemaAttributesApi
Expand Down Expand Up @@ -96,8 +96,6 @@
from .models.granta_mi_record_property_fake_attribute_identities import (
GrantaMIRecordPropertyFakeAttributeIdentities,
)
from .models.gsa_access_control_categories_info import GsaAccessControlCategoriesInfo
from .models.gsa_access_control_category import GsaAccessControlCategory
from .models.gsa_add_database import GsaAddDatabase
from .models.gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset
from .models.gsa_aggregation import GsaAggregation
Expand Down Expand Up @@ -679,6 +677,8 @@
from .models.gsa_parameter_value_type import GsaParameterValueType
from .models.gsa_parameter_with_data_value import GsaParameterWithDataValue
from .models.gsa_parameters_info import GsaParametersInfo
from .models.gsa_permission_categories_info import GsaPermissionCategoriesInfo
from .models.gsa_permission_category import GsaPermissionCategory
from .models.gsa_picture_attribute import GsaPictureAttribute
from .models.gsa_picture_datum import GsaPictureDatum
from .models.gsa_picture_datum_criterion import GsaPictureDatumCriterion
Expand Down Expand Up @@ -852,7 +852,6 @@
from .models.gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion
from .models.gsa_significant_figures_info import GsaSignificantFiguresInfo
from .models.gsa_simple_attribute_to_export import GsaSimpleAttributeToExport
from .models.gsa_slim_access_control_category import GsaSlimAccessControlCategory
from .models.gsa_slim_attribute import GsaSlimAttribute
from .models.gsa_slim_configuration import GsaSlimConfiguration
from .models.gsa_slim_constant import GsaSlimConstant
Expand All @@ -867,6 +866,7 @@
from .models.gsa_slim_named_unit import GsaSlimNamedUnit
from .models.gsa_slim_objects import GsaSlimObjects
from .models.gsa_slim_parameter import GsaSlimParameter
from .models.gsa_slim_permission_category import GsaSlimPermissionCategory
from .models.gsa_slim_profile import GsaSlimProfile
from .models.gsa_slim_profile_table import GsaSlimProfileTable
from .models.gsa_slim_record_history import GsaSlimRecordHistory
Expand Down Expand Up @@ -1052,7 +1052,6 @@
from .models.system_net_http_status_code import SystemNetHttpStatusCode

__all__ = [
"AccessControlApi",
"AggregationApi",
"DataApi",
"DataExportApi",
Expand All @@ -1066,6 +1065,7 @@
"ListManagementApi",
"ListPermissionsApi",
"MetricsApi",
"PermissionBasedAccessControlApi",
"RecordsRecordHistoriesApi",
"RecordsRecordVersionsApi",
"SchemaApi",
Expand Down Expand Up @@ -1107,8 +1107,6 @@
"FolderguidFilesBody1",
"FolderguidFilesBody2",
"GrantaMIRecordPropertyFakeAttributeIdentities",
"GsaAccessControlCategoriesInfo",
"GsaAccessControlCategory",
"GsaAddDatabase",
"GsaAddRecordHistoryToSubset",
"GsaAggregation",
Expand Down Expand Up @@ -1604,6 +1602,8 @@
"GsaParameterValueType",
"GsaParameterWithDataValue",
"GsaParametersInfo",
"GsaPermissionCategoriesInfo",
"GsaPermissionCategory",
"GsaPictureAttribute",
"GsaPictureDatum",
"GsaPictureDatumCriterion",
Expand Down Expand Up @@ -1759,7 +1759,6 @@
"GsaShortTextPrefixDatumCriterion",
"GsaSignificantFiguresInfo",
"GsaSimpleAttributeToExport",
"GsaSlimAccessControlCategory",
"GsaSlimAttribute",
"GsaSlimConfiguration",
"GsaSlimConstant",
Expand All @@ -1774,6 +1773,7 @@
"GsaSlimNamedUnit",
"GsaSlimObjects",
"GsaSlimParameter",
"GsaSlimPermissionCategory",
"GsaSlimProfile",
"GsaSlimProfileTable",
"GsaSlimRecordHistory",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
from ansys.openapi.common import ApiBase

# import apis into api package
from .access_control_api import AccessControlApi
from .aggregation_api import AggregationApi
from .data_api import DataApi
from .data_export_api import DataExportApi
Expand All @@ -40,6 +39,7 @@
from .list_management_api import ListManagementApi
from .list_permissions_api import ListPermissionsApi
from .metrics_api import MetricsApi
from .permission_based_access_control_api import PermissionBasedAccessControlApi
from .records___record_histories_api import RecordsRecordHistoriesApi
from .records___record_versions_api import RecordsRecordVersionsApi
from .schema___attributes_api import SchemaAttributesApi
Expand Down Expand Up @@ -72,7 +72,6 @@

__all__ = [
"ApiBase",
"AccessControlApi",
"AggregationApi",
"DataApi",
"DataExportApi",
Expand All @@ -86,6 +85,7 @@
"ListManagementApi",
"ListPermissionsApi",
"MetricsApi",
"PermissionBasedAccessControlApi",
"RecordsRecordHistoriesApi",
"RecordsRecordVersionsApi",
"SchemaApi",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,38 +41,40 @@
from ..models import *


class AccessControlApi(ApiBase):
class PermissionBasedAccessControlApi(ApiBase):
"""NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""

def get_access_control_categories(
self, *, database_key: "str"
) -> "Union[GsaAccessControlCategoriesInfo, None]":
"""Get all access control categories for the specified database.
def get_access_control_category(
self, *, database_key: "str", category_guid: "str"
) -> "Union[GsaPermissionCategory, None]":
"""Get a permission-based access control category with a specified guid.

This method makes a synchronous HTTP request.

Parameters
----------
database_key: str
category_guid: str

Returns
-------
Union[GsaAccessControlCategoriesInfo, None]
Union[GsaPermissionCategory, None]
"""
data = self._get_access_control_categories_with_http_info(
database_key, _return_http_data_only=True
data = self._get_access_control_category_with_http_info(
database_key, category_guid, _return_http_data_only=True
)
return data # type: ignore[no-any-return]

def _get_access_control_categories_with_http_info(
self, database_key: "str", **kwargs: Any
def _get_access_control_category_with_http_info(
self, database_key: "str", category_guid: "str", **kwargs: Any
) -> Any:
all_params = [
"database_key",
"category_guid",
"_return_http_data_only",
"_preload_content",
"_request_timeout",
Expand All @@ -82,21 +84,28 @@ def _get_access_control_categories_with_http_info(
for key, val in params["kwargs"].items():
if key not in all_params:
raise TypeError(
f"Got an unexpected keyword argument '{key}' to method get_access_control_categories"
f"Got an unexpected keyword argument '{key}' to method get_access_control_category"
)
params[key] = val
del params["kwargs"]
# verify the required parameter "database_key" is set
if "database_key" not in params or params["database_key"] is None:
raise ValueError(
"Missing the required parameter 'database_key' when calling 'get_access_control_categories'"
"Missing the required parameter 'database_key' when calling 'get_access_control_category'"
)
# verify the required parameter "category_guid" is set
if "category_guid" not in params or params["category_guid"] is None:
raise ValueError(
"Missing the required parameter 'category_guid' when calling 'get_access_control_category'"
)

collection_formats: dict[str, Any] = {}

path_params: dict[str, Any] = {}
if "database_key" in params and database_key is not None:
path_params["database-key"] = params["database_key"]
if "category_guid" in params and category_guid is not None:
path_params["category-guid"] = params["category_guid"]

query_params: list[Any] = []

Expand All @@ -110,13 +119,13 @@ def _get_access_control_categories_with_http_info(
header_params["Accept"] = self.api_client.select_header_accept(["application/json"])

response_type_map: dict[int, Optional[str]] = {
200: "GsaAccessControlCategoriesInfo",
200: "GsaPermissionCategory",
403: None,
404: None,
}

return self.api_client.call_api(
"/v1alpha/databases/{database-key}/access-control-categories",
"/v1alpha/databases/{database-key}/permission-categories/{category-guid}",
"GET",
path_params,
query_params,
Expand All @@ -131,33 +140,29 @@ def _get_access_control_categories_with_http_info(
response_type_map=response_type_map,
)

def get_access_control_category(
self, *, database_key: "str", category_guid: "str"
) -> "Union[GsaAccessControlCategory, None]":
"""Get an access control category with a specified guid.
def get_permission_categories(
self, *, database_key: "str"
) -> "Union[GsaPermissionCategoriesInfo, None]":
"""Get all permission-based access control categories for the specified database.

This method makes a synchronous HTTP request.

Parameters
----------
database_key: str
category_guid: str

Returns
-------
Union[GsaAccessControlCategory, None]
Union[GsaPermissionCategoriesInfo, None]
"""
data = self._get_access_control_category_with_http_info(
database_key, category_guid, _return_http_data_only=True
data = self._get_permission_categories_with_http_info(
database_key, _return_http_data_only=True
)
return data # type: ignore[no-any-return]

def _get_access_control_category_with_http_info(
self, database_key: "str", category_guid: "str", **kwargs: Any
) -> Any:
def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any:
all_params = [
"database_key",
"category_guid",
"_return_http_data_only",
"_preload_content",
"_request_timeout",
Expand All @@ -167,28 +172,21 @@ def _get_access_control_category_with_http_info(
for key, val in params["kwargs"].items():
if key not in all_params:
raise TypeError(
f"Got an unexpected keyword argument '{key}' to method get_access_control_category"
f"Got an unexpected keyword argument '{key}' to method get_permission_categories"
)
params[key] = val
del params["kwargs"]
# verify the required parameter "database_key" is set
if "database_key" not in params or params["database_key"] is None:
raise ValueError(
"Missing the required parameter 'database_key' when calling 'get_access_control_category'"
)
# verify the required parameter "category_guid" is set
if "category_guid" not in params or params["category_guid"] is None:
raise ValueError(
"Missing the required parameter 'category_guid' when calling 'get_access_control_category'"
"Missing the required parameter 'database_key' when calling 'get_permission_categories'"
)

collection_formats: dict[str, Any] = {}

path_params: dict[str, Any] = {}
if "database_key" in params and database_key is not None:
path_params["database-key"] = params["database_key"]
if "category_guid" in params and category_guid is not None:
path_params["category-guid"] = params["category_guid"]

query_params: list[Any] = []

Expand All @@ -202,13 +200,13 @@ def _get_access_control_category_with_http_info(
header_params["Accept"] = self.api_client.select_header_accept(["application/json"])

response_type_map: dict[int, Optional[str]] = {
200: "GsaAccessControlCategory",
200: "GsaPermissionCategoriesInfo",
403: None,
404: None,
}

return self.api_client.call_api(
"/v1alpha/databases/{database-key}/access-control-categories/{category-guid}",
"/v1alpha/databases/{database-key}/permission-categories",
"GET",
path_params,
query_params,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@
from .granta_mi_record_property_fake_attribute_identities import (
GrantaMIRecordPropertyFakeAttributeIdentities,
)
from .gsa_access_control_categories_info import GsaAccessControlCategoriesInfo
from .gsa_access_control_category import GsaAccessControlCategory
from .gsa_add_database import GsaAddDatabase
from .gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset
from .gsa_aggregation import GsaAggregation
Expand Down Expand Up @@ -604,6 +602,8 @@
from .gsa_parameter_value_type import GsaParameterValueType
from .gsa_parameter_with_data_value import GsaParameterWithDataValue
from .gsa_parameters_info import GsaParametersInfo
from .gsa_permission_categories_info import GsaPermissionCategoriesInfo
from .gsa_permission_category import GsaPermissionCategory
from .gsa_picture_attribute import GsaPictureAttribute
from .gsa_picture_datum import GsaPictureDatum
from .gsa_picture_datum_criterion import GsaPictureDatumCriterion
Expand Down Expand Up @@ -771,7 +771,6 @@
from .gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion
from .gsa_significant_figures_info import GsaSignificantFiguresInfo
from .gsa_simple_attribute_to_export import GsaSimpleAttributeToExport
from .gsa_slim_access_control_category import GsaSlimAccessControlCategory
from .gsa_slim_attribute import GsaSlimAttribute
from .gsa_slim_configuration import GsaSlimConfiguration
from .gsa_slim_constant import GsaSlimConstant
Expand All @@ -786,6 +785,7 @@
from .gsa_slim_named_unit import GsaSlimNamedUnit
from .gsa_slim_objects import GsaSlimObjects
from .gsa_slim_parameter import GsaSlimParameter
from .gsa_slim_permission_category import GsaSlimPermissionCategory
from .gsa_slim_profile import GsaSlimProfile
from .gsa_slim_profile_table import GsaSlimProfileTable
from .gsa_slim_record_history import GsaSlimRecordHistory
Expand Down Expand Up @@ -982,8 +982,6 @@
"FolderguidFilesBody1",
"FolderguidFilesBody2",
"GrantaMIRecordPropertyFakeAttributeIdentities",
"GsaAccessControlCategoriesInfo",
"GsaAccessControlCategory",
"GsaAddDatabase",
"GsaAddRecordHistoryToSubset",
"GsaAggregation",
Expand Down Expand Up @@ -1479,6 +1477,8 @@
"GsaParameterValueType",
"GsaParameterWithDataValue",
"GsaParametersInfo",
"GsaPermissionCategoriesInfo",
"GsaPermissionCategory",
"GsaPictureAttribute",
"GsaPictureDatum",
"GsaPictureDatumCriterion",
Expand Down Expand Up @@ -1634,7 +1634,6 @@
"GsaShortTextPrefixDatumCriterion",
"GsaSignificantFiguresInfo",
"GsaSimpleAttributeToExport",
"GsaSlimAccessControlCategory",
"GsaSlimAttribute",
"GsaSlimConfiguration",
"GsaSlimConstant",
Expand All @@ -1649,6 +1648,7 @@
"GsaSlimNamedUnit",
"GsaSlimObjects",
"GsaSlimParameter",
"GsaSlimPermissionCategory",
"GsaSlimProfile",
"GsaSlimProfileTable",
"GsaSlimRecordHistory",
Expand Down
Loading
Loading