diff --git a/src/README.md b/src/README.md deleted file mode 100644 index 700ce4f..0000000 --- a/src/README.md +++ /dev/null @@ -1,150 +0,0 @@ -# bloxone-python-client -The DDI Keys application is a BloxOne DDI service for managing TSIG keys and GSS-TSIG (Kerberos) keys which are used by other BloxOne DDI applications. It is part of the full-featured, DDI cloud solution that enables customers to deploy large numbers of protocol servers to deliver DNS and DHCP throughout their enterprise network. - - - -This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - -- API version: v1 -- Package version: 0.1.0 -- Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.PythonClientCodegen - -## Requirements. - -Python 3.7+ - -## Installation & Usage -### pip install - -If the python package is hosted on a repository, you can install directly using: - -```sh -pip install git+https://github.com/infobloxopen/bloxone-python-client.git -``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/infobloxopen/bloxone-python-client.git`) - -Then import the package: -```python -import bloxone_python_client -``` - -### Setuptools - -Install via [Setuptools](http://pypi.python.org/pypi/setuptools). - -```sh -python setup.py install --user -``` -(or `sudo python setup.py install` to install the package for all users) - -Then import the package: -```python -import bloxone_python_client -``` - -### Tests - -Execute `pytest` to run the tests. - -## Getting Started - -Please follow the [installation procedure](#installation--usage) and then run the following: - -```python - -import bloxone_python_client -from bloxone_python_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to http://csp.infoblox.com/api/ddi/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = bloxone_python_client.Configuration( - host = "http://csp.infoblox.com/api/ddi/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: ApiKeyAuth -configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' - - -# Enter a context with an instance of the API client -with bloxone_python_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = bloxone_python_client.GenerateTsigApi(api_client) - algorithm = 'algorithm_example' # str | The TSIG key algorithm. Valid values are: * _hmac_sha256_ * _hmac_sha1_ * _hmac_sha224_ * _hmac_sha384_ * _hmac_sha512_ Defaults to _hmac_sha256_. (optional) - - try: - # Generate TSIG key with a random secret. - api_response = api_instance.generate_tsig_generate_tsig(algorithm=algorithm) - print("The response of GenerateTsigApi->generate_tsig_generate_tsig:\n") - pprint(api_response) - except ApiException as e: - print("Exception when calling GenerateTsigApi->generate_tsig_generate_tsig: %s\n" % e) - -``` - -## Documentation for API Endpoints - -All URIs are relative to *http://csp.infoblox.com/api/ddi/v1* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*GenerateTsigApi* | [**generate_tsig_generate_tsig**](docs/GenerateTsigApi.md#generate_tsig_generate_tsig) | **GET** /keys/generate_tsig | Generate TSIG key with a random secret. -*KerberosApi* | [**kerberos_delete**](docs/KerberosApi.md#kerberos_delete) | **DELETE** /keys/kerberos/{id} | Delete the Kerberos key. -*KerberosApi* | [**kerberos_list**](docs/KerberosApi.md#kerberos_list) | **GET** /keys/kerberos | Retrieve Kerberos keys. -*KerberosApi* | [**kerberos_read**](docs/KerberosApi.md#kerberos_read) | **GET** /keys/kerberos/{id} | Retrieve the Kerberos key. -*KerberosApi* | [**kerberos_update**](docs/KerberosApi.md#kerberos_update) | **PATCH** /keys/kerberos/{id} | Update the Kerberos key. -*TsigApi* | [**tsig_create**](docs/TsigApi.md#tsig_create) | **POST** /keys/tsig | Create the TSIG key. -*TsigApi* | [**tsig_delete**](docs/TsigApi.md#tsig_delete) | **DELETE** /keys/tsig/{id} | Delete the TSIG key. -*TsigApi* | [**tsig_list**](docs/TsigApi.md#tsig_list) | **GET** /keys/tsig | Retrieve TSIG keys. -*TsigApi* | [**tsig_read**](docs/TsigApi.md#tsig_read) | **GET** /keys/tsig/{id} | Retrieve the TSIG key. -*TsigApi* | [**tsig_update**](docs/TsigApi.md#tsig_update) | **PATCH** /keys/tsig/{id} | Update the TSIG key. -*UploadApi* | [**upload_upload**](docs/UploadApi.md#upload_upload) | **POST** /keys/upload | Upload content to the keys service. - - -## Documentation For Models - - - [DdiuploadResponse](docs/DdiuploadResponse.md) - - [KerberosKey](docs/KerberosKey.md) - - [KerberosKeys](docs/KerberosKeys.md) - - [KeysCreateTSIGKeyResponse](docs/KeysCreateTSIGKeyResponse.md) - - [KeysGenerateTSIGResponse](docs/KeysGenerateTSIGResponse.md) - - [KeysGenerateTSIGResult](docs/KeysGenerateTSIGResult.md) - - [KeysListKerberosKeyResponse](docs/KeysListKerberosKeyResponse.md) - - [KeysListTSIGKeyResponse](docs/KeysListTSIGKeyResponse.md) - - [KeysReadKerberosKeyResponse](docs/KeysReadKerberosKeyResponse.md) - - [KeysReadTSIGKeyResponse](docs/KeysReadTSIGKeyResponse.md) - - [KeysTSIGKey](docs/KeysTSIGKey.md) - - [KeysUpdateKerberosKeyResponse](docs/KeysUpdateKerberosKeyResponse.md) - - [KeysUpdateTSIGKeyResponse](docs/KeysUpdateTSIGKeyResponse.md) - - [ProtobufFieldMask](docs/ProtobufFieldMask.md) - - [UploadContentType](docs/UploadContentType.md) - - [UploadRequest](docs/UploadRequest.md) - - - -## Documentation For Authorization - - -Authentication schemes defined for the API: - -### ApiKeyAuth - -- **Type**: API key -- **API key parameter name**: Authorization -- **Location**: HTTP header - - -## Author - - - - diff --git a/src/dfp/docs/DfpCreateOrUpdateResponse.md b/src/dfp/docs/DfpCreateOrUpdateResponse.md index 402a02c..18c8fc1 100644 --- a/src/dfp/docs/DfpCreateOrUpdateResponse.md +++ b/src/dfp/docs/DfpCreateOrUpdateResponse.md @@ -6,7 +6,7 @@ The DNS Forwarding Proxy update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**Dfp**](Dfp.md) | | [optional] +**results** | [**Dfp**](Dfp.md) | The DNS Forwarding Proxy object. | [optional] ## Example diff --git a/src/dfp/docs/DfpReadResponse.md b/src/dfp/docs/DfpReadResponse.md index 4527842..9e9bcd7 100644 --- a/src/dfp/docs/DfpReadResponse.md +++ b/src/dfp/docs/DfpReadResponse.md @@ -6,7 +6,7 @@ The DNS Forwarding Proxy read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**Dfp**](Dfp.md) | | [optional] +**results** | [**Dfp**](Dfp.md) | The DNS Forwarding Proxy object. | [optional] ## Example diff --git a/src/dfp/models/dfp_create_or_update_response.py b/src/dfp/models/dfp_create_or_update_response.py index 97c56d5..913512a 100644 --- a/src/dfp/models/dfp_create_or_update_response.py +++ b/src/dfp/models/dfp_create_or_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dfp.models.dfp import Dfp from typing import Optional, Set @@ -29,7 +29,8 @@ class DfpCreateOrUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[Dfp] = None + results: Optional[Dfp] = Field( + default=None, description="The DNS Forwarding Proxy object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/dfp/models/dfp_read_response.py b/src/dfp/models/dfp_read_response.py index 2f6c65a..15e6a29 100644 --- a/src/dfp/models/dfp_read_response.py +++ b/src/dfp/models/dfp_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dfp.models.dfp import Dfp from typing import Optional, Set @@ -29,7 +29,8 @@ class DfpReadResponse(BaseModel): """ # noqa: E501 - results: Optional[Dfp] = None + results: Optional[Dfp] = Field( + default=None, description="The DNS Forwarding Proxy object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/dns_config/docs/ACLItem.md b/src/dns_config/docs/ACLItem.md index 3b4f2ed..4f9236f 100644 --- a/src/dns_config/docs/ACLItem.md +++ b/src/dns_config/docs/ACLItem.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **acl** | **str** | The resource identifier. | [optional] **address** | **str** | Optional. Data for _ip_ _element_. Must be empty if _element_ is not _ip_. | [optional] **element** | **str** | Type of element. Allowed values: * _any_, * _ip_, * _acl_, * _tsig_key_. | -**tsig_key** | [**TSIGKey**](TSIGKey.md) | | [optional] +**tsig_key** | [**TSIGKey**](TSIGKey.md) | Optional. TSIG key. Must be empty if _element_ is not _tsig_key_. | [optional] ## Example diff --git a/src/dns_config/docs/AuthZone.md b/src/dns_config/docs/AuthZone.md index e254f2b..63e72bc 100644 --- a/src/dns_config/docs/AuthZone.md +++ b/src/dns_config/docs/AuthZone.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **gss_tsig_enabled** | **bool** | _gss_tsig_enabled_ enables/disables GSS-TSIG signed dynamic updates. Defaults to _false_. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_assigned_hosts** | [**List[Inheritance2AssignedHost]**](Inheritance2AssignedHost.md) | The list of the inheritance assigned hosts of the object. | [optional] [readonly] -**inheritance_sources** | [**AuthZoneInheritance**](AuthZoneInheritance.md) | | [optional] +**inheritance_sources** | [**AuthZoneInheritance**](AuthZoneInheritance.md) | Optional. Inheritance configuration. | [optional] **initial_soa_serial** | **int** | On-create-only. SOA serial is allowed to be set when the authoritative zone is created. | [optional] **internal_secondaries** | [**List[InternalSecondary]**](InternalSecondary.md) | Optional. BloxOne DDI hosts acting as internal secondaries. Order is not significant. | [optional] **mapped_subnet** | **str** | Reverse zone network address in the following format: \"ip-address/cidr\". Defaults to empty. | [optional] [readonly] @@ -34,7 +34,7 @@ Name | Type | Description | Notes **use_forwarders_for_subzones** | **bool** | Optional. Use default forwarders to resolve queries for subzones. Defaults to _true_. | [optional] **view** | **str** | The resource identifier. | [optional] **warnings** | [**List[Warning]**](Warning.md) | The list of an auth zone warnings. | [optional] [readonly] -**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | | [optional] +**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | Optional. ZoneAuthority. | [optional] ## Example diff --git a/src/dns_config/docs/AuthZoneInheritance.md b/src/dns_config/docs/AuthZoneInheritance.md index 2838882..a7d8f5d 100644 --- a/src/dns_config/docs/AuthZoneInheritance.md +++ b/src/dns_config/docs/AuthZoneInheritance.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**zone_authority** | [**InheritedZoneAuthority**](InheritedZoneAuthority.md) | | [optional] +**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _gss_tsig_enabled_ field from _AuthZone_ object. | [optional] +**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _notify_ field from _AuthZone_ object. | [optional] +**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _query_acl_ field from _AuthZone_ object. | [optional] +**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _transfer_acl_ field from _AuthZone_ object. | [optional] +**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _update_acl_ field from _AuthZone_ object. | [optional] +**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _use_forwarders_for_subzones_ field from _AuthZone_ object. | [optional] +**zone_authority** | [**InheritedZoneAuthority**](InheritedZoneAuthority.md) | Optional. Field config for _zone_authority_ field from _AuthZone_ object. | [optional] ## Example diff --git a/src/dns_config/docs/BulkCopyView.md b/src/dns_config/docs/BulkCopyView.md index 1d24267..4eedf95 100644 --- a/src/dns_config/docs/BulkCopyView.md +++ b/src/dns_config/docs/BulkCopyView.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**auth_zone_config** | [**AuthZoneConfig**](AuthZoneConfig.md) | | [optional] -**forward_zone_config** | [**ForwardZoneConfig**](ForwardZoneConfig.md) | | [optional] +**auth_zone_config** | [**AuthZoneConfig**](AuthZoneConfig.md) | Optional. Authoritative zone related configuration. | [optional] +**forward_zone_config** | [**ForwardZoneConfig**](ForwardZoneConfig.md) | Optional. Forward zone related configuration. | [optional] **recursive** | **bool** | Indicates whether child objects should be copied or not. Defaults to _false_. Reserved for future use. | [optional] **resources** | **List[str]** | The resource identifier. | -**secondary_zone_config** | [**AuthZoneConfig**](AuthZoneConfig.md) | | [optional] +**secondary_zone_config** | [**AuthZoneConfig**](AuthZoneConfig.md) | Optional. Secondary zone related configuration. | [optional] **skip_on_error** | **bool** | Indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error. Defaults to _false_. | [optional] **target** | **str** | The resource identifier. | diff --git a/src/dns_config/docs/ConvertDomainNameResponse.md b/src/dns_config/docs/ConvertDomainNameResponse.md index 8f420ec..dbd7dea 100644 --- a/src/dns_config/docs/ConvertDomainNameResponse.md +++ b/src/dns_config/docs/ConvertDomainNameResponse.md @@ -6,7 +6,7 @@ The ConvertDomainName object convert response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ConvertDomainName**](ConvertDomainName.md) | | [optional] +**result** | [**ConvertDomainName**](ConvertDomainName.md) | The ConvertDomainName object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateACLResponse.md b/src/dns_config/docs/CreateACLResponse.md index 681e8a4..aaffec2 100644 --- a/src/dns_config/docs/CreateACLResponse.md +++ b/src/dns_config/docs/CreateACLResponse.md @@ -6,7 +6,7 @@ The ACL object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ACL**](ACL.md) | | [optional] +**result** | [**ACL**](ACL.md) | The created ACL object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateAuthNSGResponse.md b/src/dns_config/docs/CreateAuthNSGResponse.md index f8a0de5..ffb9bd8 100644 --- a/src/dns_config/docs/CreateAuthNSGResponse.md +++ b/src/dns_config/docs/CreateAuthNSGResponse.md @@ -6,7 +6,7 @@ The AuthNSG object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthNSG**](AuthNSG.md) | | [optional] +**result** | [**AuthNSG**](AuthNSG.md) | The created AuthNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateAuthZoneResponse.md b/src/dns_config/docs/CreateAuthZoneResponse.md index e819d38..8eec3d4 100644 --- a/src/dns_config/docs/CreateAuthZoneResponse.md +++ b/src/dns_config/docs/CreateAuthZoneResponse.md @@ -6,7 +6,7 @@ The Authoritative Zone object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthZone**](AuthZone.md) | | [optional] +**result** | [**AuthZone**](AuthZone.md) | The created AuthZone object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateDelegationResponse.md b/src/dns_config/docs/CreateDelegationResponse.md index 868fb68..e543655 100644 --- a/src/dns_config/docs/CreateDelegationResponse.md +++ b/src/dns_config/docs/CreateDelegationResponse.md @@ -6,7 +6,7 @@ The Delegation object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Delegation**](Delegation.md) | | [optional] +**result** | [**Delegation**](Delegation.md) | The created Delegation object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateForwardNSGResponse.md b/src/dns_config/docs/CreateForwardNSGResponse.md index e9f8e4c..103ac1c 100644 --- a/src/dns_config/docs/CreateForwardNSGResponse.md +++ b/src/dns_config/docs/CreateForwardNSGResponse.md @@ -6,7 +6,7 @@ The ForwardNSG object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardNSG**](ForwardNSG.md) | | [optional] +**result** | [**ForwardNSG**](ForwardNSG.md) | The created ForwardNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateForwardZoneResponse.md b/src/dns_config/docs/CreateForwardZoneResponse.md index 3da33a6..bc6b998 100644 --- a/src/dns_config/docs/CreateForwardZoneResponse.md +++ b/src/dns_config/docs/CreateForwardZoneResponse.md @@ -6,7 +6,7 @@ The Forward Zone object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardZone**](ForwardZone.md) | | [optional] +**result** | [**ForwardZone**](ForwardZone.md) | The created Forward Zone object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateLBDNResponse.md b/src/dns_config/docs/CreateLBDNResponse.md index 234426c..44ab88d 100644 --- a/src/dns_config/docs/CreateLBDNResponse.md +++ b/src/dns_config/docs/CreateLBDNResponse.md @@ -6,7 +6,7 @@ The __LBDN__ object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**LBDN**](LBDN.md) | | [optional] +**result** | [**LBDN**](LBDN.md) | The created __LBDN__ object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateServerResponse.md b/src/dns_config/docs/CreateServerResponse.md index a04051f..2821b7f 100644 --- a/src/dns_config/docs/CreateServerResponse.md +++ b/src/dns_config/docs/CreateServerResponse.md @@ -6,7 +6,7 @@ The Server object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The created Server object. | [optional] ## Example diff --git a/src/dns_config/docs/CreateViewResponse.md b/src/dns_config/docs/CreateViewResponse.md index a4a2988..ac18532 100644 --- a/src/dns_config/docs/CreateViewResponse.md +++ b/src/dns_config/docs/CreateViewResponse.md @@ -6,7 +6,7 @@ The View object create response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**View**](View.md) | | [optional] +**result** | [**View**](View.md) | The created View object. | [optional] ## Example diff --git a/src/dns_config/docs/DNSGlobal.md b/src/dns_config/docs/DNSGlobal.md index 49832f4..3709968 100644 --- a/src/dns_config/docs/DNSGlobal.md +++ b/src/dns_config/docs/DNSGlobal.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **dnssec_root_keys** | [**List[TrustAnchor]**](TrustAnchor.md) | DNSSEC root keys. The root keys are not configurable. A default list is provided by cloud management and included here for config generation. | [optional] [readonly] **dnssec_trust_anchors** | [**List[TrustAnchor]**](TrustAnchor.md) | Optional. DNSSEC trust anchors. Error if there are list items with duplicate (_zone_, _sep_, _algorithm_) combinations. Defaults to empty. | [optional] **dnssec_validate_expiry** | **bool** | Optional. _true_ to reject expired DNSSEC keys. Ignored if either _dnssec_enabled_ or _dnssec_enable_validation_ is _false_. Defaults to _true_. | [optional] -**dtc_config** | [**DTCConfig**](DTCConfig.md) | | [optional] +**dtc_config** | [**DTCConfig**](DTCConfig.md) | Optional. DTC Configuration. | [optional] **ecs_enabled** | **bool** | Optional. _true_ to enable EDNS client subnet for recursive queries. Other _ecs_*_ fields are ignored if this field is not enabled. Defaults to _false_. | [optional] **ecs_forwarding** | **bool** | Optional. _true_ to enable ECS options in outbound queries. This functionality has additional overhead so it is disabled by default. Defaults to _false_. | [optional] **ecs_prefix_v4** | **int** | Optional. Maximum scope length for v4 ECS. Unsigned integer, min 1 max 24. Defaults to 24. | [optional] @@ -50,7 +50,7 @@ Name | Type | Description | Notes **update_acl** | [**List[ACLItem]**](ACLItem.md) | Optional. Specifies which hosts are allowed to issue Dynamic DNS updates for authoritative zones of _primary_type_ _cloud_. Defaults to empty. | [optional] **use_forwarders_for_subzones** | **bool** | Optional. Use default forwarders to resolve queries for subzones. Defaults to _true_. | [optional] **use_root_forwarders_for_local_resolution_with_b1td** | **bool** | _use_root_forwarders_for_local_resolution_with_b1td_ allows DNS recursive queries sent to root forwarders for local resolution when deployed alongside BloxOne Thread Defense. Defaults to _false_. | [optional] -**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | | [optional] +**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | Optional. ZoneAuthority. | [optional] ## Example diff --git a/src/dns_config/docs/ExternalPrimary.md b/src/dns_config/docs/ExternalPrimary.md index ddc4af6..8559a11 100644 --- a/src/dns_config/docs/ExternalPrimary.md +++ b/src/dns_config/docs/ExternalPrimary.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **nsg** | **str** | The resource identifier. | [optional] **protocol_fqdn** | **str** | FQDN of nameserver in punycode. | [optional] [readonly] **tsig_enabled** | **bool** | Optional. If enabled, secondaries will use the configured TSIG key when requesting a zone transfer from this primary. | [optional] -**tsig_key** | [**TSIGKey**](TSIGKey.md) | | [optional] +**tsig_key** | [**TSIGKey**](TSIGKey.md) | Optional. TSIG key. Error if empty while _tsig_enabled_ is _true_. | [optional] **type** | **str** | Allowed values: * _nsg_, * _primary_. | ## Example diff --git a/src/dns_config/docs/ExternalSecondary.md b/src/dns_config/docs/ExternalSecondary.md index f26261c..8f464d2 100644 --- a/src/dns_config/docs/ExternalSecondary.md +++ b/src/dns_config/docs/ExternalSecondary.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **protocol_fqdn** | **str** | FQDN of nameserver in punycode. | [optional] [readonly] **stealth** | **bool** | If enabled, the NS record and glue record will NOT be automatically generated according to secondaries nameserver assignment. Default: _false_ | [optional] **tsig_enabled** | **bool** | If enabled, secondaries will use the configured TSIG key when requesting a zone transfer. Default: _false_ | [optional] -**tsig_key** | [**TSIGKey**](TSIGKey.md) | | [optional] +**tsig_key** | [**TSIGKey**](TSIGKey.md) | TSIG key. Error if empty while _tsig_enabled_ is _true_. | [optional] ## Example diff --git a/src/dns_config/docs/Host.md b/src/dns_config/docs/Host.md index ca2c00c..b74048b 100644 --- a/src/dns_config/docs/Host.md +++ b/src/dns_config/docs/Host.md @@ -9,13 +9,13 @@ Name | Type | Description | Notes **absolute_name** | **str** | Host FQDN. | [optional] [readonly] **address** | **str** | Host's primary IP Address. | [optional] [readonly] **anycast_addresses** | **List[str]** | Anycast address configured to the host. Order is not significant. | [optional] [readonly] -**associated_server** | [**HostAssociatedServer**](HostAssociatedServer.md) | | [optional] +**associated_server** | [**HostAssociatedServer**](HostAssociatedServer.md) | Host associated server configuration. | [optional] **comment** | **str** | Host description. | [optional] [readonly] **current_version** | **str** | Host current version. | [optional] [readonly] **dfp** | **bool** | Below _dfp_ field is deprecated and not supported anymore. The indication whether or not BloxOne DDI DNS and BloxOne TD DFP are both active on the host will be migrated into the new _dfp_service_ field. | [optional] [readonly] **dfp_service** | **str** | DFP service indicates whether or not BloxOne DDI DNS and BloxOne TD DFP are both active on the host. If so, BloxOne DDI DNS will augment recursive queries and forward them to BloxOne TD DFP. Allowed values: * _unavailable_: BloxOne TD DFP application is not available, * _enabled_: BloxOne TD DFP application is available and enabled, * _disabled_: BloxOne TD DFP application is available but disabled. | [optional] [readonly] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**HostInheritance**](HostInheritance.md) | | [optional] +**inheritance_sources** | [**HostInheritance**](HostInheritance.md) | Optional. Inheritance configuration. | [optional] **kerberos_keys** | [**List[KerberosKey]**](KerberosKey.md) | Optional. _kerberos_keys_ contains a list of keys for GSS-TSIG signed dynamic updates. Defaults to empty. | [optional] **name** | **str** | Host display name. | [optional] [readonly] **ophid** | **str** | On-Prem Host ID. | [optional] [readonly] diff --git a/src/dns_config/docs/HostInheritance.md b/src/dns_config/docs/HostInheritance.md index 107e157..a0b12c9 100644 --- a/src/dns_config/docs/HostInheritance.md +++ b/src/dns_config/docs/HostInheritance.md @@ -6,7 +6,7 @@ Inheritance configuration specifies how and which fields _Host_ object inherits Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**kerberos_keys** | [**InheritedKerberosKeys**](InheritedKerberosKeys.md) | | [optional] +**kerberos_keys** | [**InheritedKerberosKeys**](InheritedKerberosKeys.md) | Optional. Field config for _kerberos_keys_ field from _Host_ object. | [optional] ## Example diff --git a/src/dns_config/docs/InheritedCustomRootNSBlock.md b/src/dns_config/docs/InheritedCustomRootNSBlock.md index 808f732..0e151ef 100644 --- a/src/dns_config/docs/InheritedCustomRootNSBlock.md +++ b/src/dns_config/docs/InheritedCustomRootNSBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | Defaults to _inherit_. | [optional] **display_name** | **str** | Human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**CustomRootNSBlock**](CustomRootNSBlock.md) | | [optional] +**value** | [**CustomRootNSBlock**](CustomRootNSBlock.md) | Inherited value. | [optional] [readonly] ## Example diff --git a/src/dns_config/docs/InheritedDNSSECValidationBlock.md b/src/dns_config/docs/InheritedDNSSECValidationBlock.md index 6cd2f9f..308fc0d 100644 --- a/src/dns_config/docs/InheritedDNSSECValidationBlock.md +++ b/src/dns_config/docs/InheritedDNSSECValidationBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | Defaults to _inherit_. | [optional] **display_name** | **str** | Human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**DNSSECValidationBlock**](DNSSECValidationBlock.md) | | [optional] +**value** | [**DNSSECValidationBlock**](DNSSECValidationBlock.md) | Inherited value. | [optional] [readonly] ## Example diff --git a/src/dns_config/docs/InheritedDtcConfig.md b/src/dns_config/docs/InheritedDtcConfig.md index 6d5e079..44d2003 100644 --- a/src/dns_config/docs/InheritedDtcConfig.md +++ b/src/dns_config/docs/InheritedDtcConfig.md @@ -6,7 +6,7 @@ Inheritance configuration for a field of type _DTCConfig_. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**default_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] +**default_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _default_ttl_ field from _DTCConfig_ object. | [optional] ## Example diff --git a/src/dns_config/docs/InheritedECSBlock.md b/src/dns_config/docs/InheritedECSBlock.md index f6c342f..0b6dbaf 100644 --- a/src/dns_config/docs/InheritedECSBlock.md +++ b/src/dns_config/docs/InheritedECSBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | Defaults to _inherit_. | [optional] **display_name** | **str** | Human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**ECSBlock**](ECSBlock.md) | | [optional] +**value** | [**ECSBlock**](ECSBlock.md) | Inherited value. | [optional] [readonly] ## Example diff --git a/src/dns_config/docs/InheritedForwardersBlock.md b/src/dns_config/docs/InheritedForwardersBlock.md index 19f7b9a..83160ef 100644 --- a/src/dns_config/docs/InheritedForwardersBlock.md +++ b/src/dns_config/docs/InheritedForwardersBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | Defaults to _inherit_. | [optional] **display_name** | **str** | Human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**ForwardersBlock**](ForwardersBlock.md) | | [optional] +**value** | [**ForwardersBlock**](ForwardersBlock.md) | Inherited value. | [optional] [readonly] ## Example diff --git a/src/dns_config/docs/InheritedZoneAuthority.md b/src/dns_config/docs/InheritedZoneAuthority.md index a7c4232..ee9fa57 100644 --- a/src/dns_config/docs/InheritedZoneAuthority.md +++ b/src/dns_config/docs/InheritedZoneAuthority.md @@ -6,14 +6,14 @@ Inheritance configuration for a field of type _ZoneAuthority_. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**default_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**expire** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**mname_block** | [**InheritedZoneAuthorityMNameBlock**](InheritedZoneAuthorityMNameBlock.md) | | [optional] -**negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**protocol_rname** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | | [optional] -**refresh** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**retry** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**rname** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | | [optional] +**default_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _default_ttl_ field from _ZoneAuthority_ object. | [optional] +**expire** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _expire_ field from _ZoneAuthority_ object. | [optional] +**mname_block** | [**InheritedZoneAuthorityMNameBlock**](InheritedZoneAuthorityMNameBlock.md) | Optional. Field config for _mname_ block from _ZoneAuthority_ object. | [optional] +**negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _negative_ttl_ field from _ZoneAuthority_ object. | [optional] +**protocol_rname** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | Optional. Field config for _protocol_rname_ field from _ZoneAuthority_ object. | [optional] +**refresh** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _refresh_ field from _ZoneAuthority_ object. | [optional] +**retry** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _retry_ field from _ZoneAuthority_ object. | [optional] +**rname** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | Optional. Field config for _rname_ field from _ZoneAuthority_ object. | [optional] ## Example diff --git a/src/dns_config/docs/InheritedZoneAuthorityMNameBlock.md b/src/dns_config/docs/InheritedZoneAuthorityMNameBlock.md index 0efa8a7..0ec5e4a 100644 --- a/src/dns_config/docs/InheritedZoneAuthorityMNameBlock.md +++ b/src/dns_config/docs/InheritedZoneAuthorityMNameBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | Defaults to _inherit_. | [optional] **display_name** | **str** | Human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**ZoneAuthorityMNameBlock**](ZoneAuthorityMNameBlock.md) | | [optional] +**value** | [**ZoneAuthorityMNameBlock**](ZoneAuthorityMNameBlock.md) | Inherited value. | [optional] [readonly] ## Example diff --git a/src/dns_config/docs/LBDN.md b/src/dns_config/docs/LBDN.md index c7337b1..cea955b 100644 --- a/src/dns_config/docs/LBDN.md +++ b/src/dns_config/docs/LBDN.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comment** | **str** | Optional. Comment for __LBDN__. | [optional] **disabled** | **bool** | Optional. _true_ to disable object. A disabled object is effectively non-existent when generating configuration. | [optional] -**dtc_policy** | [**DTCPolicy**](DTCPolicy.md) | | [optional] +**dtc_policy** | [**DTCPolicy**](DTCPolicy.md) | Optional. __DTC Policy__ information. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**TTLInheritance**](TTLInheritance.md) | | [optional] +**inheritance_sources** | [**TTLInheritance**](TTLInheritance.md) | Optional. The inheritance configuration. | [optional] **name** | **str** | Name of __LBDN__. | **precedence** | **int** | Optional. Precedence. | [optional] **tags** | **object** | Optional. The tags for __LBDN__ in JSON format. | [optional] diff --git a/src/dns_config/docs/ReadACLResponse.md b/src/dns_config/docs/ReadACLResponse.md index a48f6ab..082f0a7 100644 --- a/src/dns_config/docs/ReadACLResponse.md +++ b/src/dns_config/docs/ReadACLResponse.md @@ -6,7 +6,7 @@ The ACL object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ACL**](ACL.md) | | [optional] +**result** | [**ACL**](ACL.md) | The ACL object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadAuthNSGResponse.md b/src/dns_config/docs/ReadAuthNSGResponse.md index 5abca35..4b8ab04 100644 --- a/src/dns_config/docs/ReadAuthNSGResponse.md +++ b/src/dns_config/docs/ReadAuthNSGResponse.md @@ -6,7 +6,7 @@ The AuthNSG object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthNSG**](AuthNSG.md) | | [optional] +**result** | [**AuthNSG**](AuthNSG.md) | The AuthNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadAuthZoneResponse.md b/src/dns_config/docs/ReadAuthZoneResponse.md index 5a62a1e..b95ff99 100644 --- a/src/dns_config/docs/ReadAuthZoneResponse.md +++ b/src/dns_config/docs/ReadAuthZoneResponse.md @@ -6,7 +6,7 @@ The Authoritative Zone object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthZone**](AuthZone.md) | | [optional] +**result** | [**AuthZone**](AuthZone.md) | The AuthZone object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadDelegationResponse.md b/src/dns_config/docs/ReadDelegationResponse.md index 9ea3bc5..6f27710 100644 --- a/src/dns_config/docs/ReadDelegationResponse.md +++ b/src/dns_config/docs/ReadDelegationResponse.md @@ -6,7 +6,7 @@ The Delegation object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Delegation**](Delegation.md) | | [optional] +**result** | [**Delegation**](Delegation.md) | The Delegation object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadForwardNSGResponse.md b/src/dns_config/docs/ReadForwardNSGResponse.md index ba025f5..6d11f6b 100644 --- a/src/dns_config/docs/ReadForwardNSGResponse.md +++ b/src/dns_config/docs/ReadForwardNSGResponse.md @@ -6,7 +6,7 @@ The ForwardNSG object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardNSG**](ForwardNSG.md) | | [optional] +**result** | [**ForwardNSG**](ForwardNSG.md) | The ForwardNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadForwardZoneResponse.md b/src/dns_config/docs/ReadForwardZoneResponse.md index 4b68aa2..c4a56c5 100644 --- a/src/dns_config/docs/ReadForwardZoneResponse.md +++ b/src/dns_config/docs/ReadForwardZoneResponse.md @@ -6,7 +6,7 @@ The Forward Zone object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardZone**](ForwardZone.md) | | [optional] +**result** | [**ForwardZone**](ForwardZone.md) | The Forward Zone object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadGlobalResponse.md b/src/dns_config/docs/ReadGlobalResponse.md index e786de7..13726a5 100644 --- a/src/dns_config/docs/ReadGlobalResponse.md +++ b/src/dns_config/docs/ReadGlobalResponse.md @@ -6,7 +6,7 @@ The Global object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**DNSGlobal**](DNSGlobal.md) | | [optional] +**result** | [**DNSGlobal**](DNSGlobal.md) | The global object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadHostResponse.md b/src/dns_config/docs/ReadHostResponse.md index 4ebf8cb..22c0ed6 100644 --- a/src/dns_config/docs/ReadHostResponse.md +++ b/src/dns_config/docs/ReadHostResponse.md @@ -6,7 +6,7 @@ The DNS Host object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Host**](Host.md) | | [optional] +**result** | [**Host**](Host.md) | The DNS Host object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadLBDNResponse.md b/src/dns_config/docs/ReadLBDNResponse.md index 4e5d29f..1c077d5 100644 --- a/src/dns_config/docs/ReadLBDNResponse.md +++ b/src/dns_config/docs/ReadLBDNResponse.md @@ -6,7 +6,7 @@ The __LBDN__ object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**LBDN**](LBDN.md) | | [optional] +**result** | [**LBDN**](LBDN.md) | The __LBDN__ object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadServerResponse.md b/src/dns_config/docs/ReadServerResponse.md index f04898a..8d10285 100644 --- a/src/dns_config/docs/ReadServerResponse.md +++ b/src/dns_config/docs/ReadServerResponse.md @@ -6,7 +6,7 @@ The Server object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The Server object. | [optional] ## Example diff --git a/src/dns_config/docs/ReadViewResponse.md b/src/dns_config/docs/ReadViewResponse.md index 3445c23..c8b5a3b 100644 --- a/src/dns_config/docs/ReadViewResponse.md +++ b/src/dns_config/docs/ReadViewResponse.md @@ -6,7 +6,7 @@ The View object read response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**View**](View.md) | | [optional] +**result** | [**View**](View.md) | The View object. | [optional] ## Example diff --git a/src/dns_config/docs/Server.md b/src/dns_config/docs/Server.md index 1df51b7..3e0e13a 100644 --- a/src/dns_config/docs/Server.md +++ b/src/dns_config/docs/Server.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes **forwarders_only** | **bool** | Optional. _true_ to only forward. Defaults to _false_. | [optional] **gss_tsig_enabled** | **bool** | _gss_tsig_enabled_ enables/disables GSS-TSIG signed dynamic updates. Defaults to _false_. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**ServerInheritance**](ServerInheritance.md) | | [optional] +**inheritance_sources** | [**ServerInheritance**](ServerInheritance.md) | Optional. Inheritance configuration. | [optional] **kerberos_keys** | [**List[KerberosKey]**](KerberosKey.md) | _kerberos_keys_ contains a list of keys for GSS-TSIG signed dynamic updates. Defaults to empty. | [optional] **lame_ttl** | **int** | Optional. Unused in the current on-prem DNS server implementation. Unsigned integer, min 0 max 3600 (1h). Defaults to 600. | [optional] **log_query_response** | **bool** | Optional. Control DNS query/response logging functionality. Defaults to _true_. | [optional] diff --git a/src/dns_config/docs/ServerInheritance.md b/src/dns_config/docs/ServerInheritance.md index d54287a..6ce99f8 100644 --- a/src/dns_config/docs/ServerInheritance.md +++ b/src/dns_config/docs/ServerInheritance.md @@ -6,35 +6,35 @@ Inheritance configuration specifies how and which fields _Server_ object inherit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**add_edns_option_in_outgoing_query** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**custom_root_ns_block** | [**InheritedCustomRootNSBlock**](InheritedCustomRootNSBlock.md) | | [optional] -**dnssec_validation_block** | [**InheritedDNSSECValidationBlock**](InheritedDNSSECValidationBlock.md) | | [optional] -**ecs_block** | [**InheritedECSBlock**](InheritedECSBlock.md) | | [optional] -**filter_aaaa_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**filter_aaaa_on_v4** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | | [optional] -**forwarders_block** | [**InheritedForwardersBlock**](InheritedForwardersBlock.md) | | [optional] -**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**kerberos_keys** | [**InheritedKerberosKeys**](InheritedKerberosKeys.md) | | [optional] -**lame_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**log_query_response** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**match_recursive_only** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**max_cache_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**max_negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**minimal_responses** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**query_port** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**recursion_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**recursion_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**recursive_clients** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**resolver_query_timeout** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**secondary_axfr_query_limit** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**secondary_soa_query_limit** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**sort_list** | [**InheritedSortListItems**](InheritedSortListItems.md) | | [optional] -**synthesize_address_records_from_https** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] +**add_edns_option_in_outgoing_query** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _add_edns_option_in_outgoing_query_ field from _Server_ object. | [optional] +**custom_root_ns_block** | [**InheritedCustomRootNSBlock**](InheritedCustomRootNSBlock.md) | Optional. Field config for _custom_root_ns_block_ field from _Server_ object. | [optional] +**dnssec_validation_block** | [**InheritedDNSSECValidationBlock**](InheritedDNSSECValidationBlock.md) | Optional. Field config for _dnssec_validation_block_ field from _Server_ object. | [optional] +**ecs_block** | [**InheritedECSBlock**](InheritedECSBlock.md) | Optional. Field config for _ecs_block_ field from _Server_ object. | [optional] +**filter_aaaa_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _filter_aaaa_acl_ field from _Server_ object. | [optional] +**filter_aaaa_on_v4** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | Optional. Field config for _filter_aaaa_on_v4_ field from _Server_ object. | [optional] +**forwarders_block** | [**InheritedForwardersBlock**](InheritedForwardersBlock.md) | Optional. Field config for _forwarders_block_ field from _Server_ object. | [optional] +**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _gss_tsig_enabled_ field from _Server_ object. | [optional] +**kerberos_keys** | [**InheritedKerberosKeys**](InheritedKerberosKeys.md) | Optional. Field config for _kerberos_keys_ field from _Server_ object. | [optional] +**lame_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _lame_ttl_ field from _Server_ object. | [optional] +**log_query_response** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _log_queries_response_ field from _Server_ object. | [optional] +**match_recursive_only** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _match_recursive_only_ field from _Server_ object. | [optional] +**max_cache_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _max_cache_ttl_ field from _Server_ object. | [optional] +**max_negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _max_negative_ttl_ field from _Server_ object. | [optional] +**minimal_responses** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _minimal_responses_ field from _Server_ object. | [optional] +**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _notify_ field from _Server_ object. | [optional] +**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _query_acl_ field from _Server_ object. | [optional] +**query_port** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _query_port_ field from _Server_ object. | [optional] +**recursion_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _recursion_acl_ field from _Server_ object. | [optional] +**recursion_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _recursion_enabled_ field from _Server_ object. | [optional] +**recursive_clients** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _recursive_clients_ field from _Server_ object. | [optional] +**resolver_query_timeout** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _resolver_query_timeout_ field from _Server_ object. | [optional] +**secondary_axfr_query_limit** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _secondary_axfr_query_limit_ field from _Server_ object. | [optional] +**secondary_soa_query_limit** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _secondary_soa_query_limit_ field from _Server_ object. | [optional] +**sort_list** | [**InheritedSortListItems**](InheritedSortListItems.md) | Optional. Field config for _sort_list_ field from _Server object. | [optional] +**synthesize_address_records_from_https** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _synthesize_address_records_from_https_ field from _Server_ object. | [optional] +**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _transfer_acl_ field from _Server_ object. | [optional] +**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _update_acl_ field from _Server_ object. | [optional] +**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _use_forwarders_for_subzones_ field from _Server_ object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateACLResponse.md b/src/dns_config/docs/UpdateACLResponse.md index f863772..f203ae3 100644 --- a/src/dns_config/docs/UpdateACLResponse.md +++ b/src/dns_config/docs/UpdateACLResponse.md @@ -6,7 +6,7 @@ The ACL object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ACL**](ACL.md) | | [optional] +**result** | [**ACL**](ACL.md) | The updated ACL object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateAuthNSGResponse.md b/src/dns_config/docs/UpdateAuthNSGResponse.md index c0d5eee..efc4078 100644 --- a/src/dns_config/docs/UpdateAuthNSGResponse.md +++ b/src/dns_config/docs/UpdateAuthNSGResponse.md @@ -6,7 +6,7 @@ The AuthNSG object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthNSG**](AuthNSG.md) | | [optional] +**result** | [**AuthNSG**](AuthNSG.md) | The updated AuthNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateAuthZoneResponse.md b/src/dns_config/docs/UpdateAuthZoneResponse.md index dfe702b..30084d7 100644 --- a/src/dns_config/docs/UpdateAuthZoneResponse.md +++ b/src/dns_config/docs/UpdateAuthZoneResponse.md @@ -6,7 +6,7 @@ The Authoritative Zone object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AuthZone**](AuthZone.md) | | [optional] +**result** | [**AuthZone**](AuthZone.md) | The updated AuthZone object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateDelegationResponse.md b/src/dns_config/docs/UpdateDelegationResponse.md index 18933d4..105fa22 100644 --- a/src/dns_config/docs/UpdateDelegationResponse.md +++ b/src/dns_config/docs/UpdateDelegationResponse.md @@ -6,7 +6,7 @@ The Delegation object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Delegation**](Delegation.md) | | [optional] +**result** | [**Delegation**](Delegation.md) | The updated Delegation object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateForwardNSGResponse.md b/src/dns_config/docs/UpdateForwardNSGResponse.md index 244d02d..4d4ea32 100644 --- a/src/dns_config/docs/UpdateForwardNSGResponse.md +++ b/src/dns_config/docs/UpdateForwardNSGResponse.md @@ -6,7 +6,7 @@ The ForwardNSG object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardNSG**](ForwardNSG.md) | | [optional] +**result** | [**ForwardNSG**](ForwardNSG.md) | The updated ForwardNSG object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateForwardZoneResponse.md b/src/dns_config/docs/UpdateForwardZoneResponse.md index 3222450..18dc09a 100644 --- a/src/dns_config/docs/UpdateForwardZoneResponse.md +++ b/src/dns_config/docs/UpdateForwardZoneResponse.md @@ -6,7 +6,7 @@ The Forward Zone object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ForwardZone**](ForwardZone.md) | | [optional] +**result** | [**ForwardZone**](ForwardZone.md) | The updated Forward Zone object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateGlobalResponse.md b/src/dns_config/docs/UpdateGlobalResponse.md index 9942ba5..23c2059 100644 --- a/src/dns_config/docs/UpdateGlobalResponse.md +++ b/src/dns_config/docs/UpdateGlobalResponse.md @@ -6,7 +6,7 @@ The Global object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**DNSGlobal**](DNSGlobal.md) | | [optional] +**result** | [**DNSGlobal**](DNSGlobal.md) | The global object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateHostResponse.md b/src/dns_config/docs/UpdateHostResponse.md index da28144..47d67ea 100644 --- a/src/dns_config/docs/UpdateHostResponse.md +++ b/src/dns_config/docs/UpdateHostResponse.md @@ -6,7 +6,7 @@ The DNS Host object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Host**](Host.md) | | [optional] +**result** | [**Host**](Host.md) | The updated DNS Host object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateLBDNResponse.md b/src/dns_config/docs/UpdateLBDNResponse.md index 65c58b2..1a96e47 100644 --- a/src/dns_config/docs/UpdateLBDNResponse.md +++ b/src/dns_config/docs/UpdateLBDNResponse.md @@ -6,7 +6,7 @@ The __LBDN__ object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**LBDN**](LBDN.md) | | [optional] +**result** | [**LBDN**](LBDN.md) | The __LBDN__ object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateServerResponse.md b/src/dns_config/docs/UpdateServerResponse.md index 6921675..37501e8 100644 --- a/src/dns_config/docs/UpdateServerResponse.md +++ b/src/dns_config/docs/UpdateServerResponse.md @@ -6,7 +6,7 @@ The Server object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The Server object. | [optional] ## Example diff --git a/src/dns_config/docs/UpdateViewResponse.md b/src/dns_config/docs/UpdateViewResponse.md index e586194..a54d1ad 100644 --- a/src/dns_config/docs/UpdateViewResponse.md +++ b/src/dns_config/docs/UpdateViewResponse.md @@ -6,7 +6,7 @@ The View object update response format. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**View**](View.md) | | [optional] +**result** | [**View**](View.md) | The View object. | [optional] ## Example diff --git a/src/dns_config/docs/View.md b/src/dns_config/docs/View.md index 0e53f79..e66d6c8 100644 --- a/src/dns_config/docs/View.md +++ b/src/dns_config/docs/View.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **dnssec_root_keys** | [**List[TrustAnchor]**](TrustAnchor.md) | DNSSEC root keys. The root keys are not configurable. A default list is provided by cloud management and included here for config generation. | [optional] [readonly] **dnssec_trust_anchors** | [**List[TrustAnchor]**](TrustAnchor.md) | Optional. DNSSEC trust anchors. Error if there are list items with duplicate (_zone_, _sep_, _algorithm_) combinations. Defaults to empty. | [optional] **dnssec_validate_expiry** | **bool** | Optional. _true_ to reject expired DNSSEC keys. Ignored if either _dnssec_enabled_ or _dnssec_enable_validation_ is _false_. Defaults to _true_. | [optional] -**dtc_config** | [**DTCConfig**](DTCConfig.md) | | [optional] +**dtc_config** | [**DTCConfig**](DTCConfig.md) | Optional. DTC configuration. | [optional] **ecs_enabled** | **bool** | Optional. _true_ to enable EDNS client subnet for recursive queries. Other _ecs_*_ fields are ignored if this field is not enabled. Defaults to _false-. | [optional] **ecs_forwarding** | **bool** | Optional. _true_ to enable ECS options in outbound queries. This functionality has additional overhead so it is disabled by default. Defaults to _false_. | [optional] **ecs_prefix_v4** | **int** | Optional. Maximum scope length for v4 ECS. Unsigned integer, min 1 max 24 Defaults to 24. | [optional] @@ -30,7 +30,7 @@ Name | Type | Description | Notes **forwarders_only** | **bool** | Optional. _true_ to only forward. Defaults to _false_. | [optional] **gss_tsig_enabled** | **bool** | _gss_tsig_enabled_ enables/disables GSS-TSIG signed dynamic updates. Defaults to _false_. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**ViewInheritance**](ViewInheritance.md) | | [optional] +**inheritance_sources** | [**ViewInheritance**](ViewInheritance.md) | Optional. Inheritance configuration. | [optional] **ip_spaces** | **List[str]** | The resource identifier. | [optional] **lame_ttl** | **int** | Optional. Unused in the current on-prem DNS server implementation. Unsigned integer, min 0 max 3600 (1h). Defaults to 600. | [optional] **match_clients_acl** | [**List[ACLItem]**](ACLItem.md) | Optional. Specifies which clients have access to the view. Defaults to empty. | [optional] @@ -53,7 +53,7 @@ Name | Type | Description | Notes **updated_at** | **datetime** | The timestamp when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] **use_forwarders_for_subzones** | **bool** | Optional. Use default forwarders to resolve queries for subzones. Defaults to _true_. | [optional] **use_root_forwarders_for_local_resolution_with_b1td** | **bool** | _use_root_forwarders_for_local_resolution_with_b1td_ allows DNS recursive queries sent to root forwarders for local resolution when deployed alongside BloxOne Thread Defense. Defaults to _false_. | [optional] -**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | | [optional] +**zone_authority** | [**ZoneAuthority**](ZoneAuthority.md) | Optional. ZoneAuthority. | [optional] ## Example diff --git a/src/dns_config/docs/ViewInheritance.md b/src/dns_config/docs/ViewInheritance.md index 003501d..58c6a26 100644 --- a/src/dns_config/docs/ViewInheritance.md +++ b/src/dns_config/docs/ViewInheritance.md @@ -6,32 +6,32 @@ Inheritance configuration specifies how and which fields _View_ object inherits Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**add_edns_option_in_outgoing_query** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**custom_root_ns_block** | [**InheritedCustomRootNSBlock**](InheritedCustomRootNSBlock.md) | | [optional] -**dnssec_validation_block** | [**InheritedDNSSECValidationBlock**](InheritedDNSSECValidationBlock.md) | | [optional] -**dtc_config** | [**InheritedDtcConfig**](InheritedDtcConfig.md) | | [optional] -**ecs_block** | [**InheritedECSBlock**](InheritedECSBlock.md) | | [optional] -**edns_udp_size** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**filter_aaaa_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**filter_aaaa_on_v4** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | | [optional] -**forwarders_block** | [**InheritedForwardersBlock**](InheritedForwardersBlock.md) | | [optional] -**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**lame_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**match_recursive_only** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**max_cache_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**max_negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**max_udp_size** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | | [optional] -**minimal_responses** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**recursion_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**recursion_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**sort_list** | [**InheritedSortListItems**](InheritedSortListItems.md) | | [optional] -**synthesize_address_records_from_https** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | | [optional] -**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | | [optional] -**zone_authority** | [**InheritedZoneAuthority**](InheritedZoneAuthority.md) | | [optional] +**add_edns_option_in_outgoing_query** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _add_edns_option_in_outgoing_query_ field from _View_ object. | [optional] +**custom_root_ns_block** | [**InheritedCustomRootNSBlock**](InheritedCustomRootNSBlock.md) | Optional. Field config for _custom_root_ns_block_ field from _View_ object. | [optional] +**dnssec_validation_block** | [**InheritedDNSSECValidationBlock**](InheritedDNSSECValidationBlock.md) | Optional. Field config for _dnssec_validation_block_ field from _View_ object. | [optional] +**dtc_config** | [**InheritedDtcConfig**](InheritedDtcConfig.md) | Optional. Field config for _dtc_config_ field from _View_ object. | [optional] +**ecs_block** | [**InheritedECSBlock**](InheritedECSBlock.md) | Optional. Field config for _ecs_block_ field from _View_ object. | [optional] +**edns_udp_size** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _edns_udp_size_ field from [View] object. | [optional] +**filter_aaaa_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _filter_aaaa_acl_ field from _View_ object. | [optional] +**filter_aaaa_on_v4** | [**Inheritance2InheritedString**](Inheritance2InheritedString.md) | Optional. Field config for _filter_aaaa_on_v4_ field from _View_ object. | [optional] +**forwarders_block** | [**InheritedForwardersBlock**](InheritedForwardersBlock.md) | Optional. Field config for _forwarders_block_ field from _View_ object. | [optional] +**gss_tsig_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _gss_tsig_enabled_ field from _View_ object. | [optional] +**lame_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _lame_ttl_ field from _View_ object. | [optional] +**match_recursive_only** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _match_recursive_only_ field from _View_ object. | [optional] +**max_cache_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _max_cache_ttl_ field from _View_ object. | [optional] +**max_negative_ttl** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _max_negative_ttl_ field from _View_ object. | [optional] +**max_udp_size** | [**Inheritance2InheritedUInt32**](Inheritance2InheritedUInt32.md) | Optional. Field config for _max_udp_size_ field from [View] object. | [optional] +**minimal_responses** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _minimal_responses_ field from _View_ object. | [optional] +**notify** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _notify_ field from _View_ object. | [optional] +**query_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _query_acl_ field from _View_ object. | [optional] +**recursion_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _recursion_acl_ field from _View_ object. | [optional] +**recursion_enabled** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _recursion_enabled_ field from _View_ object. | [optional] +**sort_list** | [**InheritedSortListItems**](InheritedSortListItems.md) | Optional. Field config for _sort_list_ field from _View_ object. | [optional] +**synthesize_address_records_from_https** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Field config for _synthesize_address_records_from_https_ field from _View_ object. | [optional] +**transfer_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _transfer_acl_ field from _View_ object. | [optional] +**update_acl** | [**InheritedACLItems**](InheritedACLItems.md) | Optional. Field config for _update_acl_ field from _View_ object. | [optional] +**use_forwarders_for_subzones** | [**Inheritance2InheritedBool**](Inheritance2InheritedBool.md) | Optional. Field config for _use_forwarders_for_subzones_ field from _View_ object. | [optional] +**zone_authority** | [**InheritedZoneAuthority**](InheritedZoneAuthority.md) | Optional. Field config for _zone_authority_ field from _View_ object. | [optional] ## Example diff --git a/src/dns_config/models/acl_item.py b/src/dns_config/models/acl_item.py index e42eb90..886fabc 100644 --- a/src/dns_config/models/acl_item.py +++ b/src/dns_config/models/acl_item.py @@ -42,7 +42,10 @@ class ACLItem(BaseModel): description= "Type of element. Allowed values: * _any_, * _ip_, * _acl_, * _tsig_key_." ) - tsig_key: Optional[TSIGKey] = None + tsig_key: Optional[TSIGKey] = Field( + default=None, + description= + "Optional. TSIG key. Must be empty if _element_ is not _tsig_key_.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "access", "acl", "address", "element", "tsig_key" diff --git a/src/dns_config/models/auth_zone.py b/src/dns_config/models/auth_zone.py index c9e5817..91ea2e7 100644 --- a/src/dns_config/models/auth_zone.py +++ b/src/dns_config/models/auth_zone.py @@ -76,7 +76,8 @@ class AuthZone(BaseModel): default=None, description= "The list of the inheritance assigned hosts of the object.") - inheritance_sources: Optional[AuthZoneInheritance] = None + inheritance_sources: Optional[AuthZoneInheritance] = Field( + default=None, description="Optional. Inheritance configuration.") initial_soa_serial: Optional[StrictInt] = Field( default=None, description= @@ -143,7 +144,8 @@ class AuthZone(BaseModel): description="The resource identifier.") warnings: Optional[List[Warning]] = Field( default=None, description="The list of an auth zone warnings.") - zone_authority: Optional[ZoneAuthority] = None + zone_authority: Optional[ZoneAuthority] = Field( + default=None, description="Optional. ZoneAuthority.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "comment", "created_at", "disabled", "external_primaries", diff --git a/src/dns_config/models/auth_zone_inheritance.py b/src/dns_config/models/auth_zone_inheritance.py index 0d85038..17638b6 100644 --- a/src/dns_config/models/auth_zone_inheritance.py +++ b/src/dns_config/models/auth_zone_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inheritance2_inherited_bool import Inheritance2InheritedBool from dns_config.models.inherited_acl_items import InheritedACLItems @@ -31,13 +31,38 @@ class AuthZoneInheritance(BaseModel): """ # noqa: E501 - gss_tsig_enabled: Optional[Inheritance2InheritedBool] = None - notify: Optional[Inheritance2InheritedBool] = None - query_acl: Optional[InheritedACLItems] = None - transfer_acl: Optional[InheritedACLItems] = None - update_acl: Optional[InheritedACLItems] = None - use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = None - zone_authority: Optional[InheritedZoneAuthority] = None + gss_tsig_enabled: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _gss_tsig_enabled_ field from _AuthZone_ object." + ) + notify: Optional[Inheritance2InheritedBool] = Field( + default=None, + description="Field config for _notify_ field from _AuthZone_ object.") + query_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _query_acl_ field from _AuthZone_ object.") + transfer_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _transfer_acl_ field from _AuthZone_ object." + ) + update_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _update_acl_ field from _AuthZone_ object." + ) + use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _use_forwarders_for_subzones_ field from _AuthZone_ object." + ) + zone_authority: Optional[InheritedZoneAuthority] = Field( + default=None, + description= + "Optional. Field config for _zone_authority_ field from _AuthZone_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "gss_tsig_enabled", "notify", "query_acl", "transfer_acl", diff --git a/src/dns_config/models/bulk_copy_view.py b/src/dns_config/models/bulk_copy_view.py index a7b00de..ee126a4 100644 --- a/src/dns_config/models/bulk_copy_view.py +++ b/src/dns_config/models/bulk_copy_view.py @@ -30,15 +30,21 @@ class BulkCopyView(BaseModel): """ # noqa: E501 - auth_zone_config: Optional[AuthZoneConfig] = None - forward_zone_config: Optional[ForwardZoneConfig] = None + auth_zone_config: Optional[AuthZoneConfig] = Field( + default=None, + description="Optional. Authoritative zone related configuration.") + forward_zone_config: Optional[ForwardZoneConfig] = Field( + default=None, + description="Optional. Forward zone related configuration.") recursive: Optional[StrictBool] = Field( default=None, description= "Indicates whether child objects should be copied or not. Defaults to _false_. Reserved for future use." ) resources: List[StrictStr] = Field(description="The resource identifier.") - secondary_zone_config: Optional[AuthZoneConfig] = None + secondary_zone_config: Optional[AuthZoneConfig] = Field( + default=None, + description="Optional. Secondary zone related configuration.") skip_on_error: Optional[StrictBool] = Field( default=None, description= diff --git a/src/dns_config/models/convert_domain_name_response.py b/src/dns_config/models/convert_domain_name_response.py index ab5309f..04838fb 100644 --- a/src/dns_config/models/convert_domain_name_response.py +++ b/src/dns_config/models/convert_domain_name_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.convert_domain_name import ConvertDomainName from typing import Optional, Set @@ -27,7 +27,8 @@ class ConvertDomainNameResponse(BaseModel): """ The ConvertDomainName object convert response format. """ # noqa: E501 - result: Optional[ConvertDomainName] = None + result: Optional[ConvertDomainName] = Field( + default=None, description="The ConvertDomainName object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_acl_response.py b/src/dns_config/models/create_acl_response.py index e7af6b4..b32f946 100644 --- a/src/dns_config/models/create_acl_response.py +++ b/src/dns_config/models/create_acl_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.acl import ACL from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateACLResponse(BaseModel): """ # noqa: E501 - result: Optional[ACL] = None + result: Optional[ACL] = Field(default=None, + description="The created ACL object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_auth_nsg_response.py b/src/dns_config/models/create_auth_nsg_response.py index 7272a5b..fa47152 100644 --- a/src/dns_config/models/create_auth_nsg_response.py +++ b/src/dns_config/models/create_auth_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_nsg import AuthNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateAuthNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[AuthNSG] = None + result: Optional[AuthNSG] = Field( + default=None, description="The created AuthNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_auth_zone_response.py b/src/dns_config/models/create_auth_zone_response.py index 6cac104..1954f8a 100644 --- a/src/dns_config/models/create_auth_zone_response.py +++ b/src/dns_config/models/create_auth_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_zone import AuthZone from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateAuthZoneResponse(BaseModel): """ The Authoritative Zone object create response format. """ # noqa: E501 - result: Optional[AuthZone] = None + result: Optional[AuthZone] = Field( + default=None, description="The created AuthZone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_delegation_response.py b/src/dns_config/models/create_delegation_response.py index 44e9606..920018b 100644 --- a/src/dns_config/models/create_delegation_response.py +++ b/src/dns_config/models/create_delegation_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.delegation import Delegation from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateDelegationResponse(BaseModel): """ # noqa: E501 - result: Optional[Delegation] = None + result: Optional[Delegation] = Field( + default=None, description="The created Delegation object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_forward_nsg_response.py b/src/dns_config/models/create_forward_nsg_response.py index 020cb34..2c350f6 100644 --- a/src/dns_config/models/create_forward_nsg_response.py +++ b/src/dns_config/models/create_forward_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_nsg import ForwardNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateForwardNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[ForwardNSG] = None + result: Optional[ForwardNSG] = Field( + default=None, description="The created ForwardNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_forward_zone_response.py b/src/dns_config/models/create_forward_zone_response.py index 8532846..ff9ae23 100644 --- a/src/dns_config/models/create_forward_zone_response.py +++ b/src/dns_config/models/create_forward_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_zone import ForwardZone from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateForwardZoneResponse(BaseModel): """ The Forward Zone object create response format. """ # noqa: E501 - result: Optional[ForwardZone] = None + result: Optional[ForwardZone] = Field( + default=None, description="The created Forward Zone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_lbdn_response.py b/src/dns_config/models/create_lbdn_response.py index 93f6a4b..9747d36 100644 --- a/src/dns_config/models/create_lbdn_response.py +++ b/src/dns_config/models/create_lbdn_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.lbdn import LBDN from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateLBDNResponse(BaseModel): """ # noqa: E501 - result: Optional[LBDN] = None + result: Optional[LBDN] = Field(default=None, + description="The created __LBDN__ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_server_response.py b/src/dns_config/models/create_server_response.py index f166c34..47503e7 100644 --- a/src/dns_config/models/create_server_response.py +++ b/src/dns_config/models/create_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.server import Server from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateServerResponse(BaseModel): """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The created Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/create_view_response.py b/src/dns_config/models/create_view_response.py index 374dd21..91ded84 100644 --- a/src/dns_config/models/create_view_response.py +++ b/src/dns_config/models/create_view_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.view import View from typing import Optional, Set @@ -29,7 +29,8 @@ class CreateViewResponse(BaseModel): """ # noqa: E501 - result: Optional[View] = None + result: Optional[View] = Field(default=None, + description="The created View object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/dns_global.py b/src/dns_config/models/dns_global.py index 01b79fe..0546a36 100644 --- a/src/dns_config/models/dns_global.py +++ b/src/dns_config/models/dns_global.py @@ -75,7 +75,8 @@ class DNSGlobal(BaseModel): description= "Optional. _true_ to reject expired DNSSEC keys. Ignored if either _dnssec_enabled_ or _dnssec_enable_validation_ is _false_. Defaults to _true_." ) - dtc_config: Optional[DTCConfig] = None + dtc_config: Optional[DTCConfig] = Field( + default=None, description="Optional. DTC Configuration.") ecs_enabled: Optional[StrictBool] = Field( default=None, description= @@ -245,7 +246,8 @@ class DNSGlobal(BaseModel): description= "_use_root_forwarders_for_local_resolution_with_b1td_ allows DNS recursive queries sent to root forwarders for local resolution when deployed alongside BloxOne Thread Defense. Defaults to _false_." ) - zone_authority: Optional[ZoneAuthority] = None + zone_authority: Optional[ZoneAuthority] = Field( + default=None, description="Optional. ZoneAuthority.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "add_edns_option_in_outgoing_query", "custom_root_ns", diff --git a/src/dns_config/models/external_primary.py b/src/dns_config/models/external_primary.py index 2c1192a..8cb9f3b 100644 --- a/src/dns_config/models/external_primary.py +++ b/src/dns_config/models/external_primary.py @@ -47,7 +47,10 @@ class ExternalPrimary(BaseModel): description= "Optional. If enabled, secondaries will use the configured TSIG key when requesting a zone transfer from this primary." ) - tsig_key: Optional[TSIGKey] = None + tsig_key: Optional[TSIGKey] = Field( + default=None, + description= + "Optional. TSIG key. Error if empty while _tsig_enabled_ is _true_.") type: StrictStr = Field( description="Allowed values: * _nsg_, * _primary_.") additional_properties: Dict[str, Any] = {} diff --git a/src/dns_config/models/external_secondary.py b/src/dns_config/models/external_secondary.py index 749fcc4..a7a3972 100644 --- a/src/dns_config/models/external_secondary.py +++ b/src/dns_config/models/external_secondary.py @@ -43,7 +43,10 @@ class ExternalSecondary(BaseModel): description= "If enabled, secondaries will use the configured TSIG key when requesting a zone transfer. Default: _false_" ) - tsig_key: Optional[TSIGKey] = None + tsig_key: Optional[TSIGKey] = Field( + default=None, + description="TSIG key. Error if empty while _tsig_enabled_ is _true_." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "address", "fqdn", "protocol_fqdn", "stealth", "tsig_enabled", diff --git a/src/dns_config/models/host.py b/src/dns_config/models/host.py index 290f28a..ad3db2f 100644 --- a/src/dns_config/models/host.py +++ b/src/dns_config/models/host.py @@ -37,7 +37,8 @@ class Host(BaseModel): default=None, description= "Anycast address configured to the host. Order is not significant.") - associated_server: Optional[HostAssociatedServer] = None + associated_server: Optional[HostAssociatedServer] = Field( + default=None, description="Host associated server configuration.") comment: Optional[StrictStr] = Field(default=None, description="Host description.") current_version: Optional[StrictStr] = Field( @@ -54,7 +55,8 @@ class Host(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[HostInheritance] = None + inheritance_sources: Optional[HostInheritance] = Field( + default=None, description="Optional. Inheritance configuration.") kerberos_keys: Optional[List[KerberosKey]] = Field( default=None, description= diff --git a/src/dns_config/models/host_inheritance.py b/src/dns_config/models/host_inheritance.py index 493bda4..94605ee 100644 --- a/src/dns_config/models/host_inheritance.py +++ b/src/dns_config/models/host_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inherited_kerberos_keys import InheritedKerberosKeys from typing import Optional, Set @@ -27,7 +27,10 @@ class HostInheritance(BaseModel): """ Inheritance configuration specifies how and which fields _Host_ object inherits from _Global_ or _Server_ parent. """ # noqa: E501 - kerberos_keys: Optional[InheritedKerberosKeys] = None + kerberos_keys: Optional[InheritedKerberosKeys] = Field( + default=None, + description= + "Optional. Field config for _kerberos_keys_ field from _Host_ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["kerberos_keys"] diff --git a/src/dns_config/models/inherited_custom_root_ns_block.py b/src/dns_config/models/inherited_custom_root_ns_block.py index e7ed816..810442a 100644 --- a/src/dns_config/models/inherited_custom_root_ns_block.py +++ b/src/dns_config/models/inherited_custom_root_ns_block.py @@ -35,7 +35,8 @@ class InheritedCustomRootNSBlock(BaseModel): "Human-readable display name for the object referred to by _source_.") source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[CustomRootNSBlock] = None + value: Optional[CustomRootNSBlock] = Field(default=None, + description="Inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -72,11 +73,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/dns_config/models/inherited_dnssec_validation_block.py b/src/dns_config/models/inherited_dnssec_validation_block.py index 789213c..e32c8d4 100644 --- a/src/dns_config/models/inherited_dnssec_validation_block.py +++ b/src/dns_config/models/inherited_dnssec_validation_block.py @@ -35,7 +35,8 @@ class InheritedDNSSECValidationBlock(BaseModel): "Human-readable display name for the object referred to by _source_.") source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[DNSSECValidationBlock] = None + value: Optional[DNSSECValidationBlock] = Field( + default=None, description="Inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -72,11 +73,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/dns_config/models/inherited_dtc_config.py b/src/dns_config/models/inherited_dtc_config.py index 26370e3..d1d7487 100644 --- a/src/dns_config/models/inherited_dtc_config.py +++ b/src/dns_config/models/inherited_dtc_config.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inheritance2_inherited_u_int32 import Inheritance2InheritedUInt32 from typing import Optional, Set @@ -27,7 +27,11 @@ class InheritedDtcConfig(BaseModel): """ Inheritance configuration for a field of type _DTCConfig_. """ # noqa: E501 - default_ttl: Optional[Inheritance2InheritedUInt32] = None + default_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _default_ttl_ field from _DTCConfig_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["default_ttl"] diff --git a/src/dns_config/models/inherited_ecs_block.py b/src/dns_config/models/inherited_ecs_block.py index 7666315..269304b 100644 --- a/src/dns_config/models/inherited_ecs_block.py +++ b/src/dns_config/models/inherited_ecs_block.py @@ -35,7 +35,8 @@ class InheritedECSBlock(BaseModel): "Human-readable display name for the object referred to by _source_.") source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[ECSBlock] = None + value: Optional[ECSBlock] = Field(default=None, + description="Inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -72,11 +73,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/dns_config/models/inherited_forwarders_block.py b/src/dns_config/models/inherited_forwarders_block.py index 1c37b59..44d72a7 100644 --- a/src/dns_config/models/inherited_forwarders_block.py +++ b/src/dns_config/models/inherited_forwarders_block.py @@ -35,7 +35,8 @@ class InheritedForwardersBlock(BaseModel): "Human-readable display name for the object referred to by _source_.") source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[ForwardersBlock] = None + value: Optional[ForwardersBlock] = Field(default=None, + description="Inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -72,11 +73,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/dns_config/models/inherited_zone_authority.py b/src/dns_config/models/inherited_zone_authority.py index 7481029..77c374a 100644 --- a/src/dns_config/models/inherited_zone_authority.py +++ b/src/dns_config/models/inherited_zone_authority.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inheritance2_inherited_string import Inheritance2InheritedString from dns_config.models.inheritance2_inherited_u_int32 import Inheritance2InheritedUInt32 @@ -29,14 +29,46 @@ class InheritedZoneAuthority(BaseModel): """ Inheritance configuration for a field of type _ZoneAuthority_. """ # noqa: E501 - default_ttl: Optional[Inheritance2InheritedUInt32] = None - expire: Optional[Inheritance2InheritedUInt32] = None - mname_block: Optional[InheritedZoneAuthorityMNameBlock] = None - negative_ttl: Optional[Inheritance2InheritedUInt32] = None - protocol_rname: Optional[Inheritance2InheritedString] = None - refresh: Optional[Inheritance2InheritedUInt32] = None - retry: Optional[Inheritance2InheritedUInt32] = None - rname: Optional[Inheritance2InheritedString] = None + default_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _default_ttl_ field from _ZoneAuthority_ object." + ) + expire: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _expire_ field from _ZoneAuthority_ object." + ) + mname_block: Optional[InheritedZoneAuthorityMNameBlock] = Field( + default=None, + description= + "Optional. Field config for _mname_ block from _ZoneAuthority_ object." + ) + negative_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _negative_ttl_ field from _ZoneAuthority_ object." + ) + protocol_rname: Optional[Inheritance2InheritedString] = Field( + default=None, + description= + "Optional. Field config for _protocol_rname_ field from _ZoneAuthority_ object." + ) + refresh: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _refresh_ field from _ZoneAuthority_ object." + ) + retry: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _retry_ field from _ZoneAuthority_ object." + ) + rname: Optional[Inheritance2InheritedString] = Field( + default=None, + description= + "Optional. Field config for _rname_ field from _ZoneAuthority_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "default_ttl", "expire", "mname_block", "negative_ttl", diff --git a/src/dns_config/models/inherited_zone_authority_m_name_block.py b/src/dns_config/models/inherited_zone_authority_m_name_block.py index 877d54f..0af51b6 100644 --- a/src/dns_config/models/inherited_zone_authority_m_name_block.py +++ b/src/dns_config/models/inherited_zone_authority_m_name_block.py @@ -35,7 +35,8 @@ class InheritedZoneAuthorityMNameBlock(BaseModel): "Human-readable display name for the object referred to by _source_.") source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[ZoneAuthorityMNameBlock] = None + value: Optional[ZoneAuthorityMNameBlock] = Field( + default=None, description="Inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -72,11 +73,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/dns_config/models/lbdn.py b/src/dns_config/models/lbdn.py index 2233435..e908135 100644 --- a/src/dns_config/models/lbdn.py +++ b/src/dns_config/models/lbdn.py @@ -35,10 +35,12 @@ class LBDN(BaseModel): description= "Optional. _true_ to disable object. A disabled object is effectively non-existent when generating configuration." ) - dtc_policy: Optional[DTCPolicy] = None + dtc_policy: Optional[DTCPolicy] = Field( + default=None, description="Optional. __DTC Policy__ information.") id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[TTLInheritance] = None + inheritance_sources: Optional[TTLInheritance] = Field( + default=None, description="Optional. The inheritance configuration.") name: StrictStr = Field(description="Name of __LBDN__.") precedence: Optional[StrictInt] = Field( default=None, description="Optional. Precedence.") diff --git a/src/dns_config/models/read_acl_response.py b/src/dns_config/models/read_acl_response.py index 20b9fff..548005a 100644 --- a/src/dns_config/models/read_acl_response.py +++ b/src/dns_config/models/read_acl_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.acl import ACL from typing import Optional, Set @@ -29,7 +29,7 @@ class ReadACLResponse(BaseModel): """ # noqa: E501 - result: Optional[ACL] = None + result: Optional[ACL] = Field(default=None, description="The ACL object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_auth_nsg_response.py b/src/dns_config/models/read_auth_nsg_response.py index 2b2fabf..e1d96ea 100644 --- a/src/dns_config/models/read_auth_nsg_response.py +++ b/src/dns_config/models/read_auth_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_nsg import AuthNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadAuthNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[AuthNSG] = None + result: Optional[AuthNSG] = Field(default=None, + description="The AuthNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_auth_zone_response.py b/src/dns_config/models/read_auth_zone_response.py index 232607e..9489ca6 100644 --- a/src/dns_config/models/read_auth_zone_response.py +++ b/src/dns_config/models/read_auth_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_zone import AuthZone from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadAuthZoneResponse(BaseModel): """ The Authoritative Zone object read response format. """ # noqa: E501 - result: Optional[AuthZone] = None + result: Optional[AuthZone] = Field(default=None, + description="The AuthZone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_delegation_response.py b/src/dns_config/models/read_delegation_response.py index 4cd9f40..742fe22 100644 --- a/src/dns_config/models/read_delegation_response.py +++ b/src/dns_config/models/read_delegation_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.delegation import Delegation from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadDelegationResponse(BaseModel): """ # noqa: E501 - result: Optional[Delegation] = None + result: Optional[Delegation] = Field(default=None, + description="The Delegation object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_forward_nsg_response.py b/src/dns_config/models/read_forward_nsg_response.py index c02602d..39c610a 100644 --- a/src/dns_config/models/read_forward_nsg_response.py +++ b/src/dns_config/models/read_forward_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_nsg import ForwardNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadForwardNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[ForwardNSG] = None + result: Optional[ForwardNSG] = Field(default=None, + description="The ForwardNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_forward_zone_response.py b/src/dns_config/models/read_forward_zone_response.py index d79b587..9341a25 100644 --- a/src/dns_config/models/read_forward_zone_response.py +++ b/src/dns_config/models/read_forward_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_zone import ForwardZone from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadForwardZoneResponse(BaseModel): """ # noqa: E501 - result: Optional[ForwardZone] = None + result: Optional[ForwardZone] = Field( + default=None, description="The Forward Zone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_global_response.py b/src/dns_config/models/read_global_response.py index 3b06b30..a143f86 100644 --- a/src/dns_config/models/read_global_response.py +++ b/src/dns_config/models/read_global_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.dns_global import DNSGlobal from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadGlobalResponse(BaseModel): """ # noqa: E501 - result: Optional[DNSGlobal] = None + result: Optional[DNSGlobal] = Field(default=None, + description="The global object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_host_response.py b/src/dns_config/models/read_host_response.py index 691aa94..84a72af 100644 --- a/src/dns_config/models/read_host_response.py +++ b/src/dns_config/models/read_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.host import Host from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadHostResponse(BaseModel): """ # noqa: E501 - result: Optional[Host] = None + result: Optional[Host] = Field(default=None, + description="The DNS Host object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_lbdn_response.py b/src/dns_config/models/read_lbdn_response.py index 16803d8..b9f2194 100644 --- a/src/dns_config/models/read_lbdn_response.py +++ b/src/dns_config/models/read_lbdn_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.lbdn import LBDN from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadLBDNResponse(BaseModel): """ # noqa: E501 - result: Optional[LBDN] = None + result: Optional[LBDN] = Field(default=None, + description="The __LBDN__ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_server_response.py b/src/dns_config/models/read_server_response.py index 2af3a03..905b08b 100644 --- a/src/dns_config/models/read_server_response.py +++ b/src/dns_config/models/read_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.server import Server from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadServerResponse(BaseModel): """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/read_view_response.py b/src/dns_config/models/read_view_response.py index 7bb5094..c271593 100644 --- a/src/dns_config/models/read_view_response.py +++ b/src/dns_config/models/read_view_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.view import View from typing import Optional, Set @@ -29,7 +29,8 @@ class ReadViewResponse(BaseModel): """ # noqa: E501 - result: Optional[View] = None + result: Optional[View] = Field(default=None, + description="The View object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/server.py b/src/dns_config/models/server.py index b684aee..21ebd04 100644 --- a/src/dns_config/models/server.py +++ b/src/dns_config/models/server.py @@ -135,7 +135,8 @@ class Server(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[ServerInheritance] = None + inheritance_sources: Optional[ServerInheritance] = Field( + default=None, description="Optional. Inheritance configuration.") kerberos_keys: Optional[List[KerberosKey]] = Field( default=None, description= diff --git a/src/dns_config/models/server_inheritance.py b/src/dns_config/models/server_inheritance.py index b8ef793..0231705 100644 --- a/src/dns_config/models/server_inheritance.py +++ b/src/dns_config/models/server_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inheritance2_inherited_bool import Inheritance2InheritedBool from dns_config.models.inheritance2_inherited_string import Inheritance2InheritedString @@ -37,36 +37,144 @@ class ServerInheritance(BaseModel): Inheritance configuration specifies how and which fields _Server_ object inherits from _Global_ parent. """ # noqa: E501 add_edns_option_in_outgoing_query: Optional[ - Inheritance2InheritedBool] = None - custom_root_ns_block: Optional[InheritedCustomRootNSBlock] = None - dnssec_validation_block: Optional[InheritedDNSSECValidationBlock] = None - ecs_block: Optional[InheritedECSBlock] = None - filter_aaaa_acl: Optional[InheritedACLItems] = None - filter_aaaa_on_v4: Optional[Inheritance2InheritedString] = None - forwarders_block: Optional[InheritedForwardersBlock] = None - gss_tsig_enabled: Optional[Inheritance2InheritedBool] = None - kerberos_keys: Optional[InheritedKerberosKeys] = None - lame_ttl: Optional[Inheritance2InheritedUInt32] = None - log_query_response: Optional[Inheritance2InheritedBool] = None - match_recursive_only: Optional[Inheritance2InheritedBool] = None - max_cache_ttl: Optional[Inheritance2InheritedUInt32] = None - max_negative_ttl: Optional[Inheritance2InheritedUInt32] = None - minimal_responses: Optional[Inheritance2InheritedBool] = None - notify: Optional[Inheritance2InheritedBool] = None - query_acl: Optional[InheritedACLItems] = None - query_port: Optional[Inheritance2InheritedUInt32] = None - recursion_acl: Optional[InheritedACLItems] = None - recursion_enabled: Optional[Inheritance2InheritedBool] = None - recursive_clients: Optional[Inheritance2InheritedUInt32] = None - resolver_query_timeout: Optional[Inheritance2InheritedUInt32] = None - secondary_axfr_query_limit: Optional[Inheritance2InheritedUInt32] = None - secondary_soa_query_limit: Optional[Inheritance2InheritedUInt32] = None - sort_list: Optional[InheritedSortListItems] = None + Inheritance2InheritedBool] = Field( + default=None, + description= + "Field config for _add_edns_option_in_outgoing_query_ field from _Server_ object." + ) + custom_root_ns_block: Optional[InheritedCustomRootNSBlock] = Field( + default=None, + description= + "Optional. Field config for _custom_root_ns_block_ field from _Server_ object." + ) + dnssec_validation_block: Optional[InheritedDNSSECValidationBlock] = Field( + default=None, + description= + "Optional. Field config for _dnssec_validation_block_ field from _Server_ object." + ) + ecs_block: Optional[InheritedECSBlock] = Field( + default=None, + description= + "Optional. Field config for _ecs_block_ field from _Server_ object.") + filter_aaaa_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _filter_aaaa_acl_ field from _Server_ object." + ) + filter_aaaa_on_v4: Optional[Inheritance2InheritedString] = Field( + default=None, + description= + "Optional. Field config for _filter_aaaa_on_v4_ field from _Server_ object." + ) + forwarders_block: Optional[InheritedForwardersBlock] = Field( + default=None, + description= + "Optional. Field config for _forwarders_block_ field from _Server_ object." + ) + gss_tsig_enabled: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _gss_tsig_enabled_ field from _Server_ object." + ) + kerberos_keys: Optional[InheritedKerberosKeys] = Field( + default=None, + description= + "Optional. Field config for _kerberos_keys_ field from _Server_ object." + ) + lame_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _lame_ttl_ field from _Server_ object.") + log_query_response: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _log_queries_response_ field from _Server_ object." + ) + match_recursive_only: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _match_recursive_only_ field from _Server_ object." + ) + max_cache_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _max_cache_ttl_ field from _Server_ object." + ) + max_negative_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _max_negative_ttl_ field from _Server_ object." + ) + minimal_responses: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _minimal_responses_ field from _Server_ object." + ) + notify: Optional[Inheritance2InheritedBool] = Field( + default=None, + description="Field config for _notify_ field from _Server_ object.") + query_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _query_acl_ field from _Server_ object.") + query_port: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _query_port_ field from _Server_ object.") + recursion_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _recursion_acl_ field from _Server_ object." + ) + recursion_enabled: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _recursion_enabled_ field from _Server_ object." + ) + recursive_clients: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _recursive_clients_ field from _Server_ object." + ) + resolver_query_timeout: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _resolver_query_timeout_ field from _Server_ object." + ) + secondary_axfr_query_limit: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _secondary_axfr_query_limit_ field from _Server_ object." + ) + secondary_soa_query_limit: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _secondary_soa_query_limit_ field from _Server_ object." + ) + sort_list: Optional[InheritedSortListItems] = Field( + default=None, + description= + "Optional. Field config for _sort_list_ field from _Server object.") synthesize_address_records_from_https: Optional[ - Inheritance2InheritedBool] = None - transfer_acl: Optional[InheritedACLItems] = None - update_acl: Optional[InheritedACLItems] = None - use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = None + Inheritance2InheritedBool] = Field( + default=None, + description= + "Field config for _synthesize_address_records_from_https_ field from _Server_ object." + ) + transfer_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _transfer_acl_ field from _Server_ object." + ) + update_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _update_acl_ field from _Server_ object.") + use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _use_forwarders_for_subzones_ field from _Server_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "add_edns_option_in_outgoing_query", "custom_root_ns_block", diff --git a/src/dns_config/models/update_acl_response.py b/src/dns_config/models/update_acl_response.py index 6d43576..576a900 100644 --- a/src/dns_config/models/update_acl_response.py +++ b/src/dns_config/models/update_acl_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.acl import ACL from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateACLResponse(BaseModel): """ # noqa: E501 - result: Optional[ACL] = None + result: Optional[ACL] = Field(default=None, + description="The updated ACL object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_auth_nsg_response.py b/src/dns_config/models/update_auth_nsg_response.py index eef8b32..d559688 100644 --- a/src/dns_config/models/update_auth_nsg_response.py +++ b/src/dns_config/models/update_auth_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_nsg import AuthNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateAuthNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[AuthNSG] = None + result: Optional[AuthNSG] = Field( + default=None, description="The updated AuthNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_auth_zone_response.py b/src/dns_config/models/update_auth_zone_response.py index ae1ec62..1bb073c 100644 --- a/src/dns_config/models/update_auth_zone_response.py +++ b/src/dns_config/models/update_auth_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.auth_zone import AuthZone from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateAuthZoneResponse(BaseModel): """ The Authoritative Zone object update response format. """ # noqa: E501 - result: Optional[AuthZone] = None + result: Optional[AuthZone] = Field( + default=None, description="The updated AuthZone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_delegation_response.py b/src/dns_config/models/update_delegation_response.py index 720be7a..9f92d64 100644 --- a/src/dns_config/models/update_delegation_response.py +++ b/src/dns_config/models/update_delegation_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.delegation import Delegation from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateDelegationResponse(BaseModel): """ # noqa: E501 - result: Optional[Delegation] = None + result: Optional[Delegation] = Field( + default=None, description="The updated Delegation object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_forward_nsg_response.py b/src/dns_config/models/update_forward_nsg_response.py index 2e63ea6..c4dd638 100644 --- a/src/dns_config/models/update_forward_nsg_response.py +++ b/src/dns_config/models/update_forward_nsg_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_nsg import ForwardNSG from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateForwardNSGResponse(BaseModel): """ # noqa: E501 - result: Optional[ForwardNSG] = None + result: Optional[ForwardNSG] = Field( + default=None, description="The updated ForwardNSG object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_forward_zone_response.py b/src/dns_config/models/update_forward_zone_response.py index c190c5d..f5fb73b 100644 --- a/src/dns_config/models/update_forward_zone_response.py +++ b/src/dns_config/models/update_forward_zone_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.forward_zone import ForwardZone from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateForwardZoneResponse(BaseModel): """ The Forward Zone object update response format. """ # noqa: E501 - result: Optional[ForwardZone] = None + result: Optional[ForwardZone] = Field( + default=None, description="The updated Forward Zone object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_global_response.py b/src/dns_config/models/update_global_response.py index dc721b2..195c888 100644 --- a/src/dns_config/models/update_global_response.py +++ b/src/dns_config/models/update_global_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.dns_global import DNSGlobal from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateGlobalResponse(BaseModel): """ # noqa: E501 - result: Optional[DNSGlobal] = None + result: Optional[DNSGlobal] = Field(default=None, + description="The global object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_host_response.py b/src/dns_config/models/update_host_response.py index 8d2f233..c6556aa 100644 --- a/src/dns_config/models/update_host_response.py +++ b/src/dns_config/models/update_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.host import Host from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateHostResponse(BaseModel): """ # noqa: E501 - result: Optional[Host] = None + result: Optional[Host] = Field(default=None, + description="The updated DNS Host object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_lbdn_response.py b/src/dns_config/models/update_lbdn_response.py index 4ac05a9..dd6ea5b 100644 --- a/src/dns_config/models/update_lbdn_response.py +++ b/src/dns_config/models/update_lbdn_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.lbdn import LBDN from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateLBDNResponse(BaseModel): """ # noqa: E501 - result: Optional[LBDN] = None + result: Optional[LBDN] = Field(default=None, + description="The __LBDN__ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_server_response.py b/src/dns_config/models/update_server_response.py index d455433..ef77a99 100644 --- a/src/dns_config/models/update_server_response.py +++ b/src/dns_config/models/update_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.server import Server from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateServerResponse(BaseModel): """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/update_view_response.py b/src/dns_config/models/update_view_response.py index fe22483..2a267e7 100644 --- a/src/dns_config/models/update_view_response.py +++ b/src/dns_config/models/update_view_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.view import View from typing import Optional, Set @@ -29,7 +29,8 @@ class UpdateViewResponse(BaseModel): """ # noqa: E501 - result: Optional[View] = None + result: Optional[View] = Field(default=None, + description="The View object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_config/models/view.py b/src/dns_config/models/view.py index e441d75..6e9827d 100644 --- a/src/dns_config/models/view.py +++ b/src/dns_config/models/view.py @@ -88,7 +88,8 @@ class View(BaseModel): description= "Optional. _true_ to reject expired DNSSEC keys. Ignored if either _dnssec_enabled_ or _dnssec_enable_validation_ is _false_. Defaults to _true_." ) - dtc_config: Optional[DTCConfig] = None + dtc_config: Optional[DTCConfig] = Field( + default=None, description="Optional. DTC configuration.") ecs_enabled: Optional[StrictBool] = Field( default=None, description= @@ -144,7 +145,8 @@ class View(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[ViewInheritance] = None + inheritance_sources: Optional[ViewInheritance] = Field( + default=None, description="Optional. Inheritance configuration.") ip_spaces: Optional[List[StrictStr]] = Field( default=None, description="The resource identifier.") lame_ttl: Optional[StrictInt] = Field( @@ -245,7 +247,8 @@ class View(BaseModel): description= "_use_root_forwarders_for_local_resolution_with_b1td_ allows DNS recursive queries sent to root forwarders for local resolution when deployed alongside BloxOne Thread Defense. Defaults to _false_." ) - zone_authority: Optional[ZoneAuthority] = None + zone_authority: Optional[ZoneAuthority] = Field( + default=None, description="Optional. ZoneAuthority.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "add_edns_option_in_outgoing_query", "comment", "created_at", diff --git a/src/dns_config/models/view_inheritance.py b/src/dns_config/models/view_inheritance.py index 33d1942..1dcc308 100644 --- a/src/dns_config/models/view_inheritance.py +++ b/src/dns_config/models/view_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_config.models.inheritance2_inherited_bool import Inheritance2InheritedBool from dns_config.models.inheritance2_inherited_string import Inheritance2InheritedString @@ -38,33 +38,124 @@ class ViewInheritance(BaseModel): Inheritance configuration specifies how and which fields _View_ object inherits from [ _Global_, _Server_ ] parent. """ # noqa: E501 add_edns_option_in_outgoing_query: Optional[ - Inheritance2InheritedBool] = None - custom_root_ns_block: Optional[InheritedCustomRootNSBlock] = None - dnssec_validation_block: Optional[InheritedDNSSECValidationBlock] = None - dtc_config: Optional[InheritedDtcConfig] = None - ecs_block: Optional[InheritedECSBlock] = None - edns_udp_size: Optional[Inheritance2InheritedUInt32] = None - filter_aaaa_acl: Optional[InheritedACLItems] = None - filter_aaaa_on_v4: Optional[Inheritance2InheritedString] = None - forwarders_block: Optional[InheritedForwardersBlock] = None - gss_tsig_enabled: Optional[Inheritance2InheritedBool] = None - lame_ttl: Optional[Inheritance2InheritedUInt32] = None - match_recursive_only: Optional[Inheritance2InheritedBool] = None - max_cache_ttl: Optional[Inheritance2InheritedUInt32] = None - max_negative_ttl: Optional[Inheritance2InheritedUInt32] = None - max_udp_size: Optional[Inheritance2InheritedUInt32] = None - minimal_responses: Optional[Inheritance2InheritedBool] = None - notify: Optional[Inheritance2InheritedBool] = None - query_acl: Optional[InheritedACLItems] = None - recursion_acl: Optional[InheritedACLItems] = None - recursion_enabled: Optional[Inheritance2InheritedBool] = None - sort_list: Optional[InheritedSortListItems] = None + Inheritance2InheritedBool] = Field( + default=None, + description= + "Field config for _add_edns_option_in_outgoing_query_ field from _View_ object." + ) + custom_root_ns_block: Optional[InheritedCustomRootNSBlock] = Field( + default=None, + description= + "Optional. Field config for _custom_root_ns_block_ field from _View_ object." + ) + dnssec_validation_block: Optional[InheritedDNSSECValidationBlock] = Field( + default=None, + description= + "Optional. Field config for _dnssec_validation_block_ field from _View_ object." + ) + dtc_config: Optional[InheritedDtcConfig] = Field( + default=None, + description= + "Optional. Field config for _dtc_config_ field from _View_ object.") + ecs_block: Optional[InheritedECSBlock] = Field( + default=None, + description= + "Optional. Field config for _ecs_block_ field from _View_ object.") + edns_udp_size: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _edns_udp_size_ field from [View] object.") + filter_aaaa_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _filter_aaaa_acl_ field from _View_ object." + ) + filter_aaaa_on_v4: Optional[Inheritance2InheritedString] = Field( + default=None, + description= + "Optional. Field config for _filter_aaaa_on_v4_ field from _View_ object." + ) + forwarders_block: Optional[InheritedForwardersBlock] = Field( + default=None, + description= + "Optional. Field config for _forwarders_block_ field from _View_ object." + ) + gss_tsig_enabled: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _gss_tsig_enabled_ field from _View_ object." + ) + lame_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _lame_ttl_ field from _View_ object.") + match_recursive_only: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _match_recursive_only_ field from _View_ object." + ) + max_cache_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _max_cache_ttl_ field from _View_ object.") + max_negative_ttl: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _max_negative_ttl_ field from _View_ object." + ) + max_udp_size: Optional[Inheritance2InheritedUInt32] = Field( + default=None, + description= + "Optional. Field config for _max_udp_size_ field from [View] object.") + minimal_responses: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _minimal_responses_ field from _View_ object." + ) + notify: Optional[Inheritance2InheritedBool] = Field( + default=None, + description="Field config for _notify_ field from _View_ object.") + query_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _query_acl_ field from _View_ object.") + recursion_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _recursion_acl_ field from _View_ object.") + recursion_enabled: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _recursion_enabled_ field from _View_ object." + ) + sort_list: Optional[InheritedSortListItems] = Field( + default=None, + description= + "Optional. Field config for _sort_list_ field from _View_ object.") synthesize_address_records_from_https: Optional[ - Inheritance2InheritedBool] = None - transfer_acl: Optional[InheritedACLItems] = None - update_acl: Optional[InheritedACLItems] = None - use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = None - zone_authority: Optional[InheritedZoneAuthority] = None + Inheritance2InheritedBool] = Field( + default=None, + description= + "Field config for _synthesize_address_records_from_https_ field from _View_ object." + ) + transfer_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _transfer_acl_ field from _View_ object.") + update_acl: Optional[InheritedACLItems] = Field( + default=None, + description= + "Optional. Field config for _update_acl_ field from _View_ object.") + use_forwarders_for_subzones: Optional[Inheritance2InheritedBool] = Field( + default=None, + description= + "Optional. Field config for _use_forwarders_for_subzones_ field from _View_ object." + ) + zone_authority: Optional[InheritedZoneAuthority] = Field( + default=None, + description= + "Optional. Field config for _zone_authority_ field from _View_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "add_edns_option_in_outgoing_query", "custom_root_ns_block", diff --git a/src/dns_data/docs/CreateRecordResponse.md b/src/dns_data/docs/CreateRecordResponse.md index 1bd7c1c..4a76d8e 100644 --- a/src/dns_data/docs/CreateRecordResponse.md +++ b/src/dns_data/docs/CreateRecordResponse.md @@ -6,7 +6,7 @@ The response format to create the __Record__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Record**](Record.md) | | [optional] +**result** | [**Record**](Record.md) | The created Record object. | [optional] ## Example diff --git a/src/dns_data/docs/ReadRecordResponse.md b/src/dns_data/docs/ReadRecordResponse.md index 9f51ed5..3d7fdb3 100644 --- a/src/dns_data/docs/ReadRecordResponse.md +++ b/src/dns_data/docs/ReadRecordResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Record__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Record**](Record.md) | | [optional] +**result** | [**Record**](Record.md) | The Record object. | [optional] ## Example diff --git a/src/dns_data/docs/Record.md b/src/dns_data/docs/Record.md index 58f3f21..6e69ae8 100644 --- a/src/dns_data/docs/Record.md +++ b/src/dns_data/docs/Record.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **dns_name_in_zone** | **str** | The DNS protocol textual representation of the relative owner name for the DNS zone. | [optional] [readonly] **dns_rdata** | **str** | The DNS protocol textual representation of the DNS resource record data. | [optional] [readonly] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**RecordInheritance**](RecordInheritance.md) | | [optional] +**inheritance_sources** | [**RecordInheritance**](RecordInheritance.md) | The inheritance configuration. | [optional] **ipam_host** | **str** | The resource identifier. | [optional] [readonly] **name_in_zone** | **str** | The relative owner name to the zone origin. Must be specified for creating the DNS resource record and is read only for other operations. | [optional] **options** | **object** | The DNS resource record type-specific non-protocol options. Valid value for _A_ (Address) and _AAAA_ (IPv6 Address) records: Option | Description -----------|----------------------------------------- create_ptr | A boolean flag which can be set to _true_ for POST operation to automatically create the corresponding PTR record. check_rmz | A boolean flag which can be set to _true_ for POST operation to check the existence of reverse zone for creating the corresponding PTR record. Only applicable if the _create_ptr_ option is set to _true_. Valid value for _PTR_ (Pointer) records: Option | Description -----------|---------------------------------------- address | For GET operation it contains the IPv4 or IPv6 address represented by the PTR record.<br><br>For POST and PATCH operations it can be used to create/update a PTR record based on the IP address it represents. In this case, in addition to the _address_ in the options field, need to specify the _view_ field. | | [optional] diff --git a/src/dns_data/models/create_record_response.py b/src/dns_data/models/create_record_response.py index ad6ff96..140f731 100644 --- a/src/dns_data/models/create_record_response.py +++ b/src/dns_data/models/create_record_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_data.models.record import Record from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateRecordResponse(BaseModel): """ The response format to create the __Record__ object. """ # noqa: E501 - result: Optional[Record] = None + result: Optional[Record] = Field(default=None, + description="The created Record object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_data/models/read_record_response.py b/src/dns_data/models/read_record_response.py index 9c5b881..219ede8 100644 --- a/src/dns_data/models/read_record_response.py +++ b/src/dns_data/models/read_record_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from dns_data.models.record import Record from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadRecordResponse(BaseModel): """ The response format to retrieve the __Record__ object. """ # noqa: E501 - result: Optional[Record] = None + result: Optional[Record] = Field(default=None, + description="The Record object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/dns_data/models/record.py b/src/dns_data/models/record.py index 155ca2a..ac06c65 100644 --- a/src/dns_data/models/record.py +++ b/src/dns_data/models/record.py @@ -73,7 +73,8 @@ class Record(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[RecordInheritance] = None + inheritance_sources: Optional[RecordInheritance] = Field( + default=None, description="The inheritance configuration.") ipam_host: Optional[StrictStr] = Field( default=None, description="The resource identifier.") name_in_zone: Optional[StrictStr] = Field( diff --git a/src/fw/docs/AccessCodeCreateResponse.md b/src/fw/docs/AccessCodeCreateResponse.md index 0b7de27..625b988 100644 --- a/src/fw/docs/AccessCodeCreateResponse.md +++ b/src/fw/docs/AccessCodeCreateResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**AccessCode**](AccessCode.md) | | [optional] +**results** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | [optional] ## Example diff --git a/src/fw/docs/AccessCodeReadResponse.md b/src/fw/docs/AccessCodeReadResponse.md index fb8ff64..701ea10 100644 --- a/src/fw/docs/AccessCodeReadResponse.md +++ b/src/fw/docs/AccessCodeReadResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**AccessCode**](AccessCode.md) | | [optional] +**results** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | [optional] ## Example diff --git a/src/fw/docs/AccessCodeUpdateResponse.md b/src/fw/docs/AccessCodeUpdateResponse.md index bd3a8aa..cf0a9d0 100644 --- a/src/fw/docs/AccessCodeUpdateResponse.md +++ b/src/fw/docs/AccessCodeUpdateResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**AccessCode**](AccessCode.md) | | [optional] +**results** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | [optional] ## Example diff --git a/src/fw/docs/AppApprovalsReplaceRequest.md b/src/fw/docs/AppApprovalsReplaceRequest.md index 487c508..fccf903 100644 --- a/src/fw/docs/AppApprovalsReplaceRequest.md +++ b/src/fw/docs/AppApprovalsReplaceRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **approvals** | [**List[AppApproval]**](AppApproval.md) | | [optional] -**fields** | [**ProtobufFieldMask**](ProtobufFieldMask.md) | | [optional] +**fields** | [**ProtobufFieldMask**](ProtobufFieldMask.md) | Field Mask. | [optional] ## Example diff --git a/src/fw/docs/AppApprovalsUpdateRequest.md b/src/fw/docs/AppApprovalsUpdateRequest.md index 4936f2e..362f54a 100644 --- a/src/fw/docs/AppApprovalsUpdateRequest.md +++ b/src/fw/docs/AppApprovalsUpdateRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fields** | [**ProtobufFieldMask**](ProtobufFieldMask.md) | | [optional] +**fields** | [**ProtobufFieldMask**](ProtobufFieldMask.md) | Field Mask. | [optional] **inserted_approvals** | [**List[AppApproval]**](AppApproval.md) | | [optional] **removed_approvals** | [**List[AppApprovalRemovalRequest]**](AppApprovalRemovalRequest.md) | | [optional] diff --git a/src/fw/docs/ApplicationFilterCreateResponse.md b/src/fw/docs/ApplicationFilterCreateResponse.md index eb509d4..2eb72e2 100644 --- a/src/fw/docs/ApplicationFilterCreateResponse.md +++ b/src/fw/docs/ApplicationFilterCreateResponse.md @@ -6,7 +6,7 @@ The Application Filter create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**ApplicationFilter**](ApplicationFilter.md) | | [optional] +**results** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | [optional] ## Example diff --git a/src/fw/docs/ApplicationFilterReadResponse.md b/src/fw/docs/ApplicationFilterReadResponse.md index bd2e53c..6afda56 100644 --- a/src/fw/docs/ApplicationFilterReadResponse.md +++ b/src/fw/docs/ApplicationFilterReadResponse.md @@ -6,7 +6,7 @@ The Application Filter read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**ApplicationFilter**](ApplicationFilter.md) | | [optional] +**results** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | [optional] ## Example diff --git a/src/fw/docs/ApplicationFilterUpdateResponse.md b/src/fw/docs/ApplicationFilterUpdateResponse.md index 25fcacb..8223877 100644 --- a/src/fw/docs/ApplicationFilterUpdateResponse.md +++ b/src/fw/docs/ApplicationFilterUpdateResponse.md @@ -6,7 +6,7 @@ The Application Filter update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**ApplicationFilter**](ApplicationFilter.md) | | [optional] +**results** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | [optional] ## Example diff --git a/src/fw/docs/CategoryFilterCreateResponse.md b/src/fw/docs/CategoryFilterCreateResponse.md index 5ec622b..18c1b0e 100644 --- a/src/fw/docs/CategoryFilterCreateResponse.md +++ b/src/fw/docs/CategoryFilterCreateResponse.md @@ -6,7 +6,7 @@ The Category Filter create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CategoryFilter**](CategoryFilter.md) | | [optional] +**results** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | [optional] ## Example diff --git a/src/fw/docs/CategoryFilterReadResponse.md b/src/fw/docs/CategoryFilterReadResponse.md index 947d9c4..5768fb1 100644 --- a/src/fw/docs/CategoryFilterReadResponse.md +++ b/src/fw/docs/CategoryFilterReadResponse.md @@ -6,7 +6,7 @@ The Category Filter read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CategoryFilter**](CategoryFilter.md) | | [optional] +**results** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | [optional] ## Example diff --git a/src/fw/docs/CategoryFilterUpdateResponse.md b/src/fw/docs/CategoryFilterUpdateResponse.md index fa9a822..69de76a 100644 --- a/src/fw/docs/CategoryFilterUpdateResponse.md +++ b/src/fw/docs/CategoryFilterUpdateResponse.md @@ -6,7 +6,7 @@ The Category Filter update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CategoryFilter**](CategoryFilter.md) | | [optional] +**results** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | [optional] ## Example diff --git a/src/fw/docs/InternalDomainsCreateResponse.md b/src/fw/docs/InternalDomainsCreateResponse.md index 9258de8..f6e9215 100644 --- a/src/fw/docs/InternalDomainsCreateResponse.md +++ b/src/fw/docs/InternalDomainsCreateResponse.md @@ -6,7 +6,7 @@ The Internal Domains create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**InternalDomains**](InternalDomains.md) | | [optional] +**results** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | [optional] ## Example diff --git a/src/fw/docs/InternalDomainsReadResponse.md b/src/fw/docs/InternalDomainsReadResponse.md index 93255e7..4051c51 100644 --- a/src/fw/docs/InternalDomainsReadResponse.md +++ b/src/fw/docs/InternalDomainsReadResponse.md @@ -6,7 +6,7 @@ The Internal Domains read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**InternalDomains**](InternalDomains.md) | | [optional] +**results** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | [optional] ## Example diff --git a/src/fw/docs/InternalDomainsUpdateResponse.md b/src/fw/docs/InternalDomainsUpdateResponse.md index 0581658..ac265c2 100644 --- a/src/fw/docs/InternalDomainsUpdateResponse.md +++ b/src/fw/docs/InternalDomainsUpdateResponse.md @@ -6,7 +6,7 @@ The Internal domains update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**InternalDomains**](InternalDomains.md) | | [optional] +**results** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | [optional] ## Example diff --git a/src/fw/docs/NamedListCreateResponse.md b/src/fw/docs/NamedListCreateResponse.md index fb5ba3f..bbce4cf 100644 --- a/src/fw/docs/NamedListCreateResponse.md +++ b/src/fw/docs/NamedListCreateResponse.md @@ -6,7 +6,7 @@ The Named List create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NamedList**](NamedList.md) | | [optional] +**results** | [**NamedList**](NamedList.md) | The Named List object. | [optional] ## Example diff --git a/src/fw/docs/NamedListReadResponse.md b/src/fw/docs/NamedListReadResponse.md index fd0cc7f..086c498 100644 --- a/src/fw/docs/NamedListReadResponse.md +++ b/src/fw/docs/NamedListReadResponse.md @@ -6,7 +6,7 @@ The Named List read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NamedList**](NamedList.md) | | [optional] +**results** | [**NamedList**](NamedList.md) | The Named List object. | [optional] ## Example diff --git a/src/fw/docs/NamedListUpdateResponse.md b/src/fw/docs/NamedListUpdateResponse.md index f4b5be1..540b517 100644 --- a/src/fw/docs/NamedListUpdateResponse.md +++ b/src/fw/docs/NamedListUpdateResponse.md @@ -6,7 +6,7 @@ The Named List update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NamedList**](NamedList.md) | | [optional] +**results** | [**NamedList**](NamedList.md) | The Named List object. | [optional] ## Example diff --git a/src/fw/docs/NetAddrDfpAssignment.md b/src/fw/docs/NetAddrDfpAssignment.md index c60834d..d68b043 100644 --- a/src/fw/docs/NetAddrDfpAssignment.md +++ b/src/fw/docs/NetAddrDfpAssignment.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **external_scope_id** | **str** | external scope ID, UUID | [optional] **host_id** | **str** | Host reference, UUID | [optional] **ip_space_id** | **str** | IPSpace reference, UUID | [optional] -**scope_type** | [**NetAddrDfpAssignmentScopeType**](NetAddrDfpAssignmentScopeType.md) | | [optional] +**scope_type** | [**NetAddrDfpAssignmentScopeType**](NetAddrDfpAssignmentScopeType.md) | scope type | [optional] **start** | **str** | Start and end pair of addresses used for range scope type | [optional] ## Example diff --git a/src/fw/docs/NetworkListCreateResponse.md b/src/fw/docs/NetworkListCreateResponse.md index 7421347..37ee717 100644 --- a/src/fw/docs/NetworkListCreateResponse.md +++ b/src/fw/docs/NetworkListCreateResponse.md @@ -6,7 +6,7 @@ The Network List create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NetworkList**](NetworkList.md) | | [optional] +**results** | [**NetworkList**](NetworkList.md) | The Network List object. | [optional] ## Example diff --git a/src/fw/docs/NetworkListReadResponse.md b/src/fw/docs/NetworkListReadResponse.md index fc0e7f3..47b4965 100644 --- a/src/fw/docs/NetworkListReadResponse.md +++ b/src/fw/docs/NetworkListReadResponse.md @@ -6,7 +6,7 @@ The Network List read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NetworkList**](NetworkList.md) | | [optional] +**results** | [**NetworkList**](NetworkList.md) | The Network List object. | [optional] ## Example diff --git a/src/fw/docs/NetworkListUpdateResponse.md b/src/fw/docs/NetworkListUpdateResponse.md index bdc7c8d..24e781a 100644 --- a/src/fw/docs/NetworkListUpdateResponse.md +++ b/src/fw/docs/NetworkListUpdateResponse.md @@ -6,7 +6,7 @@ The Network List update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**NetworkList**](NetworkList.md) | | [optional] +**results** | [**NetworkList**](NetworkList.md) | The Network List object. | [optional] ## Example diff --git a/src/fw/docs/SecurityPolicyCreateResponse.md b/src/fw/docs/SecurityPolicyCreateResponse.md index fedf98d..ee8d70f 100644 --- a/src/fw/docs/SecurityPolicyCreateResponse.md +++ b/src/fw/docs/SecurityPolicyCreateResponse.md @@ -6,7 +6,7 @@ The Security Policy create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**SecurityPolicy**](SecurityPolicy.md) | | [optional] +**results** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | [optional] ## Example diff --git a/src/fw/docs/SecurityPolicyReadResponse.md b/src/fw/docs/SecurityPolicyReadResponse.md index 8b80f2d..2e063ed 100644 --- a/src/fw/docs/SecurityPolicyReadResponse.md +++ b/src/fw/docs/SecurityPolicyReadResponse.md @@ -6,7 +6,7 @@ The Security Policy read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**SecurityPolicy**](SecurityPolicy.md) | | [optional] +**results** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | [optional] ## Example diff --git a/src/fw/docs/SecurityPolicyUpdateResponse.md b/src/fw/docs/SecurityPolicyUpdateResponse.md index 383b61a..0937ae6 100644 --- a/src/fw/docs/SecurityPolicyUpdateResponse.md +++ b/src/fw/docs/SecurityPolicyUpdateResponse.md @@ -6,7 +6,7 @@ The Security Policy update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**SecurityPolicy**](SecurityPolicy.md) | | [optional] +**results** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | [optional] ## Example diff --git a/src/fw/docs/ThreatFeed.md b/src/fw/docs/ThreatFeed.md index 8aa899d..466847a 100644 --- a/src/fw/docs/ThreatFeed.md +++ b/src/fw/docs/ThreatFeed.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **description** | **str** | The brief description for the thread feed. | [optional] [readonly] **key** | **str** | The TSIG key of the threat feed. | [optional] [readonly] **name** | **str** | The name of the thread feed. | [optional] [readonly] -**source** | [**ThreatFeedSource**](ThreatFeedSource.md) | | [optional] +**source** | [**ThreatFeedSource**](ThreatFeedSource.md) | The source of the threat feed. | [optional] [readonly] **threat_level** | **str** | The Threat Level of the Feed. | [optional] [readonly] ## Example diff --git a/src/fw/models/access_code_create_response.py b/src/fw/models/access_code_create_response.py index f4b727a..f046d3a 100644 --- a/src/fw/models/access_code_create_response.py +++ b/src/fw/models/access_code_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.access_code import AccessCode from typing import Optional, Set @@ -29,7 +29,8 @@ class AccessCodeCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[AccessCode] = None + results: Optional[AccessCode] = Field( + default=None, description="The Bypass Code object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/access_code_read_response.py b/src/fw/models/access_code_read_response.py index e46621a..1bd80c1 100644 --- a/src/fw/models/access_code_read_response.py +++ b/src/fw/models/access_code_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.access_code import AccessCode from typing import Optional, Set @@ -29,7 +29,8 @@ class AccessCodeReadResponse(BaseModel): """ # noqa: E501 - results: Optional[AccessCode] = None + results: Optional[AccessCode] = Field( + default=None, description="The Bypass Code object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/access_code_update_response.py b/src/fw/models/access_code_update_response.py index ed6e356..8eb7e90 100644 --- a/src/fw/models/access_code_update_response.py +++ b/src/fw/models/access_code_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.access_code import AccessCode from typing import Optional, Set @@ -29,7 +29,8 @@ class AccessCodeUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[AccessCode] = None + results: Optional[AccessCode] = Field( + default=None, description="The Bypass Code object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/app_approvals_replace_request.py b/src/fw/models/app_approvals_replace_request.py index 28db19f..80694d0 100644 --- a/src/fw/models/app_approvals_replace_request.py +++ b/src/fw/models/app_approvals_replace_request.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.app_approval import AppApproval from fw.models.protobuf_field_mask import ProtobufFieldMask @@ -31,7 +31,8 @@ class AppApprovalsReplaceRequest(BaseModel): # noqa: E501 approvals: Optional[List[AppApproval]] = None - fields: Optional[ProtobufFieldMask] = None + fields: Optional[ProtobufFieldMask] = Field(default=None, + description="Field Mask.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["approvals", "fields"] diff --git a/src/fw/models/app_approvals_update_request.py b/src/fw/models/app_approvals_update_request.py index 163a84f..02cd3d0 100644 --- a/src/fw/models/app_approvals_update_request.py +++ b/src/fw/models/app_approvals_update_request.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.app_approval import AppApproval from fw.models.app_approval_removal_request import AppApprovalRemovalRequest @@ -31,7 +31,8 @@ class AppApprovalsUpdateRequest(BaseModel): """ # noqa: E501 - fields: Optional[ProtobufFieldMask] = None + fields: Optional[ProtobufFieldMask] = Field(default=None, + description="Field Mask.") inserted_approvals: Optional[List[AppApproval]] = None removed_approvals: Optional[List[AppApprovalRemovalRequest]] = None additional_properties: Dict[str, Any] = {} diff --git a/src/fw/models/application_filter_create_response.py b/src/fw/models/application_filter_create_response.py index 57864d1..bfb0a0e 100644 --- a/src/fw/models/application_filter_create_response.py +++ b/src/fw/models/application_filter_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.application_filter import ApplicationFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class ApplicationFilterCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[ApplicationFilter] = None + results: Optional[ApplicationFilter] = Field( + default=None, description="The Application Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/application_filter_read_response.py b/src/fw/models/application_filter_read_response.py index ad0bea6..f22b94e 100644 --- a/src/fw/models/application_filter_read_response.py +++ b/src/fw/models/application_filter_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.application_filter import ApplicationFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class ApplicationFilterReadResponse(BaseModel): """ # noqa: E501 - results: Optional[ApplicationFilter] = None + results: Optional[ApplicationFilter] = Field( + default=None, description="The Application Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/application_filter_update_response.py b/src/fw/models/application_filter_update_response.py index 851a076..6c09c9c 100644 --- a/src/fw/models/application_filter_update_response.py +++ b/src/fw/models/application_filter_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.application_filter import ApplicationFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class ApplicationFilterUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[ApplicationFilter] = None + results: Optional[ApplicationFilter] = Field( + default=None, description="The Application Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/category_filter_create_response.py b/src/fw/models/category_filter_create_response.py index 33b3ef3..ea84325 100644 --- a/src/fw/models/category_filter_create_response.py +++ b/src/fw/models/category_filter_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.category_filter import CategoryFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class CategoryFilterCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[CategoryFilter] = None + results: Optional[CategoryFilter] = Field( + default=None, description="The Category Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/category_filter_read_response.py b/src/fw/models/category_filter_read_response.py index f106fad..d9cbec7 100644 --- a/src/fw/models/category_filter_read_response.py +++ b/src/fw/models/category_filter_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.category_filter import CategoryFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class CategoryFilterReadResponse(BaseModel): """ # noqa: E501 - results: Optional[CategoryFilter] = None + results: Optional[CategoryFilter] = Field( + default=None, description="The Category Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/category_filter_update_response.py b/src/fw/models/category_filter_update_response.py index 8c510df..146e4e3 100644 --- a/src/fw/models/category_filter_update_response.py +++ b/src/fw/models/category_filter_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.category_filter import CategoryFilter from typing import Optional, Set @@ -29,7 +29,8 @@ class CategoryFilterUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[CategoryFilter] = None + results: Optional[CategoryFilter] = Field( + default=None, description="The Category Filter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/internal_domains_create_response.py b/src/fw/models/internal_domains_create_response.py index 56a480e..4021015 100644 --- a/src/fw/models/internal_domains_create_response.py +++ b/src/fw/models/internal_domains_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.internal_domains import InternalDomains from typing import Optional, Set @@ -29,7 +29,8 @@ class InternalDomainsCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[InternalDomains] = None + results: Optional[InternalDomains] = Field( + default=None, description="The Internal Domains object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/internal_domains_read_response.py b/src/fw/models/internal_domains_read_response.py index 838c73a..8f902a5 100644 --- a/src/fw/models/internal_domains_read_response.py +++ b/src/fw/models/internal_domains_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.internal_domains import InternalDomains from typing import Optional, Set @@ -29,7 +29,8 @@ class InternalDomainsReadResponse(BaseModel): """ # noqa: E501 - results: Optional[InternalDomains] = None + results: Optional[InternalDomains] = Field( + default=None, description="The Internal Domains object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/internal_domains_update_response.py b/src/fw/models/internal_domains_update_response.py index 1fc2327..94faefd 100644 --- a/src/fw/models/internal_domains_update_response.py +++ b/src/fw/models/internal_domains_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.internal_domains import InternalDomains from typing import Optional, Set @@ -29,7 +29,8 @@ class InternalDomainsUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[InternalDomains] = None + results: Optional[InternalDomains] = Field( + default=None, description="The Internal Domains object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/named_list_create_response.py b/src/fw/models/named_list_create_response.py index 0f42c7d..0ab8b70 100644 --- a/src/fw/models/named_list_create_response.py +++ b/src/fw/models/named_list_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.named_list import NamedList from typing import Optional, Set @@ -29,7 +29,8 @@ class NamedListCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[NamedList] = None + results: Optional[NamedList] = Field(default=None, + description="The Named List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/named_list_read_response.py b/src/fw/models/named_list_read_response.py index bec83b2..0c14452 100644 --- a/src/fw/models/named_list_read_response.py +++ b/src/fw/models/named_list_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.named_list import NamedList from typing import Optional, Set @@ -29,7 +29,8 @@ class NamedListReadResponse(BaseModel): """ # noqa: E501 - results: Optional[NamedList] = None + results: Optional[NamedList] = Field(default=None, + description="The Named List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/named_list_update_response.py b/src/fw/models/named_list_update_response.py index 832c05d..8178132 100644 --- a/src/fw/models/named_list_update_response.py +++ b/src/fw/models/named_list_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.named_list import NamedList from typing import Optional, Set @@ -29,7 +29,8 @@ class NamedListUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[NamedList] = None + results: Optional[NamedList] = Field(default=None, + description="The Named List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/net_addr_dfp_assignment.py b/src/fw/models/net_addr_dfp_assignment.py index 6547f92..590c019 100644 --- a/src/fw/models/net_addr_dfp_assignment.py +++ b/src/fw/models/net_addr_dfp_assignment.py @@ -44,7 +44,8 @@ class NetAddrDfpAssignment(BaseModel): description="Host reference, UUID") ip_space_id: Optional[StrictStr] = Field( default=None, description="IPSpace reference, UUID") - scope_type: Optional[NetAddrDfpAssignmentScopeType] = None + scope_type: Optional[NetAddrDfpAssignmentScopeType] = Field( + default=None, description="scope type") start: Optional[StrictStr] = Field( default=None, description="Start and end pair of addresses used for range scope type" diff --git a/src/fw/models/network_list_create_response.py b/src/fw/models/network_list_create_response.py index a923b2e..bcb319e 100644 --- a/src/fw/models/network_list_create_response.py +++ b/src/fw/models/network_list_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.network_list import NetworkList from typing import Optional, Set @@ -29,7 +29,8 @@ class NetworkListCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[NetworkList] = None + results: Optional[NetworkList] = Field( + default=None, description="The Network List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/network_list_read_response.py b/src/fw/models/network_list_read_response.py index 3f51ca6..b29aaeb 100644 --- a/src/fw/models/network_list_read_response.py +++ b/src/fw/models/network_list_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.network_list import NetworkList from typing import Optional, Set @@ -29,7 +29,8 @@ class NetworkListReadResponse(BaseModel): """ # noqa: E501 - results: Optional[NetworkList] = None + results: Optional[NetworkList] = Field( + default=None, description="The Network List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/network_list_update_response.py b/src/fw/models/network_list_update_response.py index 13bd2a2..abe1c6a 100644 --- a/src/fw/models/network_list_update_response.py +++ b/src/fw/models/network_list_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.network_list import NetworkList from typing import Optional, Set @@ -29,7 +29,8 @@ class NetworkListUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[NetworkList] = None + results: Optional[NetworkList] = Field( + default=None, description="The Network List object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/security_policy_create_response.py b/src/fw/models/security_policy_create_response.py index 6f921a5..860b87f 100644 --- a/src/fw/models/security_policy_create_response.py +++ b/src/fw/models/security_policy_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.security_policy import SecurityPolicy from typing import Optional, Set @@ -29,7 +29,8 @@ class SecurityPolicyCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[SecurityPolicy] = None + results: Optional[SecurityPolicy] = Field( + default=None, description="The Security Policy object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/security_policy_read_response.py b/src/fw/models/security_policy_read_response.py index 5cd1c9a..5540858 100644 --- a/src/fw/models/security_policy_read_response.py +++ b/src/fw/models/security_policy_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.security_policy import SecurityPolicy from typing import Optional, Set @@ -29,7 +29,8 @@ class SecurityPolicyReadResponse(BaseModel): """ # noqa: E501 - results: Optional[SecurityPolicy] = None + results: Optional[SecurityPolicy] = Field( + default=None, description="The Security Policy object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/security_policy_update_response.py b/src/fw/models/security_policy_update_response.py index 0327c88..29ff39e 100644 --- a/src/fw/models/security_policy_update_response.py +++ b/src/fw/models/security_policy_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from fw.models.security_policy import SecurityPolicy from typing import Optional, Set @@ -29,7 +29,8 @@ class SecurityPolicyUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[SecurityPolicy] = None + results: Optional[SecurityPolicy] = Field( + default=None, description="The Security Policy object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/fw/models/threat_feed.py b/src/fw/models/threat_feed.py index ef900f0..267d237 100644 --- a/src/fw/models/threat_feed.py +++ b/src/fw/models/threat_feed.py @@ -35,7 +35,8 @@ class ThreatFeed(BaseModel): default=None, description="The TSIG key of the threat feed.") name: Optional[StrictStr] = Field( default=None, description="The name of the thread feed.") - source: Optional[ThreatFeedSource] = None + source: Optional[ThreatFeedSource] = Field( + default=None, description="The source of the threat feed.") threat_level: Optional[StrictStr] = Field( default=None, description="The Threat Level of the Feed.") additional_properties: Dict[str, Any] = {} @@ -78,6 +79,7 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ @@ -85,6 +87,7 @@ def to_dict(self) -> Dict[str, Any]: "description", "key", "name", + "source", "threat_level", "additional_properties", ]) diff --git a/src/infra_mgmt/docs/DetailHost.md b/src/infra_mgmt/docs/DetailHost.md index ac4e9d1..d219e5e 100644 --- a/src/infra_mgmt/docs/DetailHost.md +++ b/src/infra_mgmt/docs/DetailHost.md @@ -18,12 +18,12 @@ Name | Type | Description | Notes **ip_address** | **str** | The IP address of the Host. | [optional] **ip_space** | **str** | The IP Space of the Host. | [optional] **legacy_id** | **str** | The legacy Host object identifier. | [optional] -**location** | [**DetailLocation**](DetailLocation.md) | | [optional] +**location** | [**DetailLocation**](DetailLocation.md) | Location that this Host is associated with. | [optional] **mac_address** | **str** | The MAC address of the Host. | [optional] **maintenance_mode** | **str** | | [optional] **nat_ip** | **str** | The NAT IP address of the Host. | [optional] **ophid** | **str** | The unique On-Prem Host ID generated by the On-Prem device and assigned to the Host once it is registered and logged into the Infoblox Cloud. | [optional] -**pool** | [**PoolInfo**](PoolInfo.md) | | [optional] +**pool** | [**PoolInfo**](PoolInfo.md) | Pool information for this Host (internal). | [optional] **serial_number** | **str** | The unique serial number of the Host. | [optional] **services** | [**List[DetailHostServiceConfig]**](DetailHostServiceConfig.md) | The list of Services deployed on this Host. | [optional] **site_id** | **str** | The Site ID of the Host. | [optional] diff --git a/src/infra_mgmt/docs/DetailHostServiceConfig.md b/src/infra_mgmt/docs/DetailHostServiceConfig.md index e6413c3..af2344f 100644 --- a/src/infra_mgmt/docs/DetailHostServiceConfig.md +++ b/src/infra_mgmt/docs/DetailHostServiceConfig.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **service_id** | **str** | The resource identifier. | [optional] **service_name** | **str** | The name of the Service. | [optional] **service_type** | **str** | The type of the Service deployed on the Host (`dns`, `cdc`, etc.). | [optional] -**status** | [**ShortServiceStatus**](ShortServiceStatus.md) | | [optional] +**status** | [**ShortServiceStatus**](ShortServiceStatus.md) | Service status information. | [optional] **upgraded_at** | **datetime** | The timestamp of the latest upgrade of the Host-specific Service configuration. | [optional] ## Example diff --git a/src/infra_mgmt/docs/DetailService.md b/src/infra_mgmt/docs/DetailService.md index 41833cc..165c792 100644 --- a/src/infra_mgmt/docs/DetailService.md +++ b/src/infra_mgmt/docs/DetailService.md @@ -15,9 +15,9 @@ Name | Type | Description | Notes **hosts** | [**List[DetailServiceHost]**](DetailServiceHost.md) | List of Hosts on which this Service is deployed. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] **interface_labels** | **List[str]** | List of interfaces on which this Service can operate. | [optional] -**location** | [**DetailLocation**](DetailLocation.md) | | [optional] +**location** | [**DetailLocation**](DetailLocation.md) | Location that this Host is associated with. | [optional] **name** | **str** | The name of the Service. | [optional] -**pool** | [**PoolInfo**](PoolInfo.md) | | [optional] +**pool** | [**PoolInfo**](PoolInfo.md) | Pool information for this Service (internal). | [optional] **service_type** | **str** | The type of the Service deployed on the Host (`dns`, `cdc`, etc.). | [optional] **tags** | **object** | Tags associated with this Service. | [optional] **updated_at** | **datetime** | Timestamp of the latest update on Service. | [optional] diff --git a/src/infra_mgmt/docs/DetailServiceHost.md b/src/infra_mgmt/docs/DetailServiceHost.md index 930790d..b02a635 100644 --- a/src/infra_mgmt/docs/DetailServiceHost.md +++ b/src/infra_mgmt/docs/DetailServiceHost.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **composite_status** | **str** | Composite Status of the Host (`online`, `degraded`, `error`, `offline`, `pending`, `awaiting approval`). | [optional] -**config** | [**DetailServiceHostConfig**](DetailServiceHostConfig.md) | | [optional] +**config** | [**DetailServiceHostConfig**](DetailServiceHostConfig.md) | List of Host-specific configurations of this Service. | [optional] **display_name** | **str** | The name of the Host (unique). | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] **ip_address** | **str** | The IP address of the Host. | [optional] diff --git a/src/infra_mgmt/docs/DetailServiceHostConfig.md b/src/infra_mgmt/docs/DetailServiceHostConfig.md index a48f940..b39a694 100644 --- a/src/infra_mgmt/docs/DetailServiceHostConfig.md +++ b/src/infra_mgmt/docs/DetailServiceHostConfig.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **current_version** | **str** | The current version of the Service deployed on the Host. | [optional] -**status** | [**ShortServiceStatus**](ShortServiceStatus.md) | | [optional] +**status** | [**ShortServiceStatus**](ShortServiceStatus.md) | Service status information. | [optional] **upgraded_at** | **datetime** | | [optional] ## Example diff --git a/src/infra_mgmt/models/detail_host.py b/src/infra_mgmt/models/detail_host.py index d77af36..cfaffc4 100644 --- a/src/infra_mgmt/models/detail_host.py +++ b/src/infra_mgmt/models/detail_host.py @@ -65,7 +65,9 @@ class DetailHost(BaseModel): default=None, description="The IP Space of the Host.") legacy_id: Optional[StrictStr] = Field( default=None, description="The legacy Host object identifier.") - location: Optional[DetailLocation] = None + location: Optional[DetailLocation] = Field( + default=None, + description="Location that this Host is associated with.") mac_address: Optional[StrictStr] = Field( default=None, description="The MAC address of the Host.") maintenance_mode: Optional[StrictStr] = None @@ -76,7 +78,8 @@ class DetailHost(BaseModel): description= "The unique On-Prem Host ID generated by the On-Prem device and assigned to the Host once it is registered and logged into the Infoblox Cloud." ) - pool: Optional[PoolInfo] = None + pool: Optional[PoolInfo] = Field( + default=None, description="Pool information for this Host (internal).") serial_number: Optional[StrictStr] = Field( default=None, description="The unique serial number of the Host.") services: Optional[List[DetailHostServiceConfig]] = Field( diff --git a/src/infra_mgmt/models/detail_host_service_config.py b/src/infra_mgmt/models/detail_host_service_config.py index c4f7f0c..5c79abe 100644 --- a/src/infra_mgmt/models/detail_host_service_config.py +++ b/src/infra_mgmt/models/detail_host_service_config.py @@ -41,7 +41,8 @@ class DetailHostServiceConfig(BaseModel): default=None, description= "The type of the Service deployed on the Host (`dns`, `cdc`, etc.).") - status: Optional[ShortServiceStatus] = None + status: Optional[ShortServiceStatus] = Field( + default=None, description="Service status information.") upgraded_at: Optional[datetime] = Field( default=None, description= diff --git a/src/infra_mgmt/models/detail_service.py b/src/infra_mgmt/models/detail_service.py index 58a6fdb..2dc1b12 100644 --- a/src/infra_mgmt/models/detail_service.py +++ b/src/infra_mgmt/models/detail_service.py @@ -62,10 +62,14 @@ class DetailService(BaseModel): interface_labels: Optional[List[StrictStr]] = Field( default=None, description="List of interfaces on which this Service can operate.") - location: Optional[DetailLocation] = None + location: Optional[DetailLocation] = Field( + default=None, + description="Location that this Host is associated with.") name: Optional[StrictStr] = Field(default=None, description="The name of the Service.") - pool: Optional[PoolInfo] = None + pool: Optional[PoolInfo] = Field( + default=None, + description="Pool information for this Service (internal).") service_type: Optional[StrictStr] = Field( default=None, description= diff --git a/src/infra_mgmt/models/detail_service_host.py b/src/infra_mgmt/models/detail_service_host.py index 35644d6..d0ef05d 100644 --- a/src/infra_mgmt/models/detail_service_host.py +++ b/src/infra_mgmt/models/detail_service_host.py @@ -34,7 +34,9 @@ class DetailServiceHost(BaseModel): description= "Composite Status of the Host (`online`, `degraded`, `error`, `offline`, `pending`, `awaiting approval`)." ) - config: Optional[DetailServiceHostConfig] = None + config: Optional[DetailServiceHostConfig] = Field( + default=None, + description="List of Host-specific configurations of this Service.") display_name: Optional[StrictStr] = Field( default=None, description="The name of the Host (unique).") id: Optional[StrictStr] = Field(default=None, diff --git a/src/infra_mgmt/models/detail_service_host_config.py b/src/infra_mgmt/models/detail_service_host_config.py index 494232c..52ade08 100644 --- a/src/infra_mgmt/models/detail_service_host_config.py +++ b/src/infra_mgmt/models/detail_service_host_config.py @@ -33,7 +33,8 @@ class DetailServiceHostConfig(BaseModel): current_version: Optional[StrictStr] = Field( default=None, description="The current version of the Service deployed on the Host.") - status: Optional[ShortServiceStatus] = None + status: Optional[ShortServiceStatus] = Field( + default=None, description="Service status information.") upgraded_at: Optional[datetime] = None additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ diff --git a/src/infra_mgmt/test/test_create_service_response.py b/src/infra_mgmt/test/test_create_service_response.py index 3bac797..55f56ad 100644 --- a/src/infra_mgmt/test/test_create_service_response.py +++ b/src/infra_mgmt/test/test_create_service_response.py @@ -57,9 +57,7 @@ def make_instance(self, include_optional) -> CreateServiceResponse: name = 'Example Service Name', pool_id = 'dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6', service_type = 'dns', - tags = { - 'key' : '' - }, + tags = infra_mgmt.models.tags.tags(), updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ) else: diff --git a/src/infra_mgmt/test/test_detail_api.py b/src/infra_mgmt/test/test_detail_api.py index 0371181..82a57ee 100644 --- a/src/infra_mgmt/test/test_detail_api.py +++ b/src/infra_mgmt/test/test_detail_api.py @@ -25,15 +25,15 @@ def setUp(self) -> None: def tearDown(self) -> None: pass - def test_detail_hosts_list(self) -> None: - """Test case for detail_hosts_list + def test_hosts_list(self) -> None: + """Test case for hosts_list List all the Hosts along with its associated Services (applications). """ pass - def test_detail_services_list(self) -> None: - """Test case for detail_services_list + def test_services_list(self) -> None: + """Test case for services_list List all the Services (applications) along with its associated Hosts. """ diff --git a/src/infra_mgmt/test/test_get_service_response.py b/src/infra_mgmt/test/test_get_service_response.py index 8239e5a..8601315 100644 --- a/src/infra_mgmt/test/test_get_service_response.py +++ b/src/infra_mgmt/test/test_get_service_response.py @@ -57,9 +57,7 @@ def make_instance(self, include_optional) -> GetServiceResponse: name = 'Example Service Name', pool_id = 'dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6', service_type = 'dns', - tags = { - 'key' : '' - }, + tags = infra_mgmt.models.tags.tags(), updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ) else: diff --git a/src/infra_mgmt/test/test_hosts_api.py b/src/infra_mgmt/test/test_hosts_api.py index 3941d00..8c06929 100644 --- a/src/infra_mgmt/test/test_hosts_api.py +++ b/src/infra_mgmt/test/test_hosts_api.py @@ -25,64 +25,64 @@ def setUp(self) -> None: def tearDown(self) -> None: pass - def test_hosts_assign_tags(self) -> None: - """Test case for hosts_assign_tags + def test_assign_tags(self) -> None: + """Test case for assign_tags Assign tags for list of hosts. """ pass - def test_hosts_create(self) -> None: - """Test case for hosts_create + def test_create(self) -> None: + """Test case for create Create a Host resource. """ pass - def test_hosts_delete(self) -> None: - """Test case for hosts_delete + def test_delete(self) -> None: + """Test case for delete Delete a Host resource. """ pass - def test_hosts_disconnect(self) -> None: - """Test case for hosts_disconnect + def test_disconnect(self) -> None: + """Test case for disconnect Disconnect a Host by resource ID. """ pass - def test_hosts_list(self) -> None: - """Test case for hosts_list + def test_list(self) -> None: + """Test case for list List all the Host resources for an account. """ pass - def test_hosts_read(self) -> None: - """Test case for hosts_read + def test_read(self) -> None: + """Test case for read Get a Host resource. """ pass - def test_hosts_replace(self) -> None: - """Test case for hosts_replace + def test_replace(self) -> None: + """Test case for replace Migrate a Host's configuration from one to another. """ pass - def test_hosts_unassign_tags(self) -> None: - """Test case for hosts_unassign_tags + def test_unassign_tags(self) -> None: + """Test case for unassign_tags Unassign tag for the list hosts. """ pass - def test_hosts_update(self) -> None: - """Test case for hosts_update + def test_update(self) -> None: + """Test case for update Update a Host resource. """ diff --git a/src/infra_mgmt/test/test_list_service_response.py b/src/infra_mgmt/test/test_list_service_response.py index 56c209d..fd830eb 100644 --- a/src/infra_mgmt/test/test_list_service_response.py +++ b/src/infra_mgmt/test/test_list_service_response.py @@ -62,9 +62,7 @@ def make_instance(self, include_optional) -> ListServiceResponse: name = 'Example Service Name', pool_id = 'dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6', service_type = 'dns', - tags = { - 'key' : '' - }, + tags = infra_mgmt.models.tags.tags(), updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ] ) diff --git a/src/infra_mgmt/test/test_service.py b/src/infra_mgmt/test/test_service.py index 99f18c5..4e17ba6 100644 --- a/src/infra_mgmt/test/test_service.py +++ b/src/infra_mgmt/test/test_service.py @@ -56,9 +56,7 @@ def make_instance(self, include_optional) -> Service: name = 'Example Service Name', pool_id = 'dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6', service_type = 'dns', - tags = { - 'key' : '' - }, + tags = infra_mgmt.models.tags.tags(), updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') ) else: diff --git a/src/infra_mgmt/test/test_services_api.py b/src/infra_mgmt/test/test_services_api.py index b50275e..d696271 100644 --- a/src/infra_mgmt/test/test_services_api.py +++ b/src/infra_mgmt/test/test_services_api.py @@ -25,43 +25,43 @@ def setUp(self) -> None: def tearDown(self) -> None: pass - def test_services_applications(self) -> None: - """Test case for services_applications + def test_applications(self) -> None: + """Test case for applications List applications (Service types) for a particular account. """ pass - def test_services_create(self) -> None: - """Test case for services_create + def test_create(self) -> None: + """Test case for create Create a Service resource. """ pass - def test_services_delete(self) -> None: - """Test case for services_delete + def test_delete(self) -> None: + """Test case for delete Delete a Service resource. """ pass - def test_services_list(self) -> None: - """Test case for services_list + def test_list(self) -> None: + """Test case for list List all the Service resources for an account. """ pass - def test_services_read(self) -> None: - """Test case for services_read + def test_read(self) -> None: + """Test case for read Read a Service resource. """ pass - def test_services_update(self) -> None: - """Test case for services_update + def test_update(self) -> None: + """Test case for update Update a Service resource. """ diff --git a/src/infra_mgmt/test/test_update_service_response.py b/src/infra_mgmt/test/test_update_service_response.py index 66de81f..df05379 100644 --- a/src/infra_mgmt/test/test_update_service_response.py +++ b/src/infra_mgmt/test/test_update_service_response.py @@ -57,9 +57,7 @@ def make_instance(self, include_optional) -> UpdateServiceResponse: name = 'Example Service Name', pool_id = 'dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6', service_type = 'dns', - tags = { - 'key' : '' - }, + tags = infra_mgmt.models.tags.tags(), updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ) else: diff --git a/src/infra_provision/docs/JoinToken.md b/src/infra_provision/docs/JoinToken.md index 4188eee..a72307a 100644 --- a/src/infra_provision/docs/JoinToken.md +++ b/src/infra_provision/docs/JoinToken.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **id** | **str** | The resource identifier. | [optional] [readonly] **last_used_at** | **datetime** | | [optional] [readonly] **name** | **str** | | [optional] -**status** | [**JoinTokenJoinTokenStatus**](JoinTokenJoinTokenStatus.md) | | [optional] +**status** | [**JoinTokenJoinTokenStatus**](JoinTokenJoinTokenStatus.md) | derived field, \"active\" when expires_at and deleted_at are null. | [optional] [readonly] **tags** | **object** | | [optional] **token_id** | **str** | first half of the token. | [optional] [readonly] **use_counter** | **int** | | [optional] [readonly] diff --git a/src/infra_provision/models/join_token.py b/src/infra_provision/models/join_token.py index 13cebe0..533f8d6 100644 --- a/src/infra_provision/models/join_token.py +++ b/src/infra_provision/models/join_token.py @@ -37,7 +37,10 @@ class JoinToken(BaseModel): description="The resource identifier.") last_used_at: Optional[datetime] = None name: Optional[StrictStr] = None - status: Optional[JoinTokenJoinTokenStatus] = None + status: Optional[JoinTokenJoinTokenStatus] = Field( + default=None, + description= + "derived field, \"active\" when expires_at and deleted_at are null.") tags: Optional[Dict[str, Any]] = None token_id: Optional[StrictStr] = Field( default=None, description="first half of the token.") @@ -82,12 +85,14 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "deleted_at", "id", "last_used_at", + "status", "token_id", "use_counter", "additional_properties", diff --git a/src/ipam/docs/Address.md b/src/ipam/docs/Address.md index 0583298..8af3002 100644 --- a/src/ipam/docs/Address.md +++ b/src/ipam/docs/Address.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **address** | **str** | The address in form \"a.b.c.d\". | **comment** | **str** | The description for the address object. May contain 0 to 1024 characters. Can include UTF-8. | [optional] **created_at** | **datetime** | Time when the object has been created. | [optional] [readonly] -**dhcp_info** | [**DHCPInfo**](DHCPInfo.md) | | [optional] +**dhcp_info** | [**DHCPInfo**](DHCPInfo.md) | The DHCP information associated with this object. | [optional] [readonly] **disable_dhcp** | **bool** | Read only. Represent the value of the same field in the associated _dhcp/fixed_address_ object. | [optional] [readonly] **discovery_attrs** | **object** | The discovery attributes for this address in JSON format. | [optional] [readonly] **discovery_metadata** | **object** | The discovery metadata for this address in JSON format. | [optional] [readonly] diff --git a/src/ipam/docs/AddressBlock.md b/src/ipam/docs/AddressBlock.md index 29d688f..20eb63d 100644 --- a/src/ipam/docs/AddressBlock.md +++ b/src/ipam/docs/AddressBlock.md @@ -7,7 +7,7 @@ An __AddressBlock__ object (_ipam/address_block_) is a set of contiguous IP addr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **str** | The address field in form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the _cidr_ field. When reading, the _address_ field is always in the form “a.b.c.d”. | [optional] -**asm_config** | [**ASMConfig**](ASMConfig.md) | | [optional] +**asm_config** | [**ASMConfig**](ASMConfig.md) | The Automated Scope Management configuration for the address block. | [optional] **asm_scope_flag** | **int** | Incremented by 1 if the IP address usage limits for automated scope management are exceeded for any subnets in the address block. | [optional] [readonly] **cidr** | **int** | The CIDR of the address block. This is required, if _address_ does not specify it in its input. | [optional] **comment** | **str** | The description for the address block. May contain 0 to 1024 characters. Can include UTF-8. | [optional] @@ -21,9 +21,9 @@ Name | Type | Description | Notes **ddns_ttl_percent** | **float** | DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75). Defaults to unspecified. | [optional] **ddns_update_on_renew** | **bool** | Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed. Defaults to _false_. | [optional] **ddns_use_conflict_resolution** | **bool** | When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_. | [optional] -**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | | [optional] +**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | The shared DHCP configuration that controls how leases are issued for the address block. | [optional] **dhcp_options** | [**List[OptionItem]**](OptionItem.md) | The list of DHCP options for the address block. May be either a specific option or a group of options. | [optional] -**dhcp_utilization** | [**DHCPUtilization**](DHCPUtilization.md) | | [optional] +**dhcp_utilization** | [**DHCPUtilization**](DHCPUtilization.md) | The utilization of IP addresses within the DHCP ranges of the address block. | [optional] [readonly] **discovery_attrs** | **object** | The discovery attributes for this address block in JSON format. | [optional] [readonly] **discovery_metadata** | **object** | The discovery metadata for this address block in JSON format. | [optional] [readonly] **header_option_filename** | **str** | The configuration for header option filename field. | [optional] @@ -34,17 +34,17 @@ Name | Type | Description | Notes **hostname_rewrite_regex** | **str** | The regex bracket expression to match valid characters. Must begin with \"[\" and end with \"]\" and be a compilable POSIX regex. Defaults to \"[^a-zA-Z0-9_.]\". | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_parent** | **str** | The resource identifier. | [optional] -**inheritance_sources** | [**DHCPInheritance**](DHCPInheritance.md) | | [optional] +**inheritance_sources** | [**DHCPInheritance**](DHCPInheritance.md) | The DHCP inheritance configuration for the address block. | [optional] **name** | **str** | The name of the address block. May contain 1 to 256 characters. Can include UTF-8. | [optional] **parent** | **str** | The resource identifier. | [optional] **protocol** | **str** | The type of protocol of address block (_ip4_ or _ip6_). | [optional] [readonly] **space** | **str** | The resource identifier. | [optional] **tags** | **object** | The tags for the address block in JSON format. | [optional] -**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | | [optional] +**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | The IP address utilization thresholds for the address block. | [optional] **updated_at** | **datetime** | Time when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] **usage** | **List[str]** | The usage is a combination of indicators, each tracking a specific associated use. Listed below are usage indicators with their meaning: usage indicator | description ---------------------- | -------------------------------- _IPAM_ | AddressBlock is managed in BloxOne DDI. _DISCOVERED_ | AddressBlock is discovered by some network discovery probe like Network Insight or NetMRI in NIOS. | [optional] [readonly] -**utilization** | [**Utilization**](Utilization.md) | | [optional] -**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | | [optional] +**utilization** | [**Utilization**](Utilization.md) | The IPV4 address utilization statistics for the address block. | [optional] [readonly] +**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | The utilization of IPV6 addresses in the Address block. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/CreateASMResponse.md b/src/ipam/docs/CreateASMResponse.md index 95d2083..2f2c993 100644 --- a/src/ipam/docs/CreateASMResponse.md +++ b/src/ipam/docs/CreateASMResponse.md @@ -6,7 +6,7 @@ The response format to update subnet and range for ASM. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ASM**](ASM.md) | | [optional] +**result** | [**ASM**](ASM.md) | The ASM object. | [optional] ## Example diff --git a/src/ipam/docs/CreateAddressBlockResponse.md b/src/ipam/docs/CreateAddressBlockResponse.md index ba965f5..9217ff1 100644 --- a/src/ipam/docs/CreateAddressBlockResponse.md +++ b/src/ipam/docs/CreateAddressBlockResponse.md @@ -6,7 +6,7 @@ The response format to create the __AddressBlock__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AddressBlock**](AddressBlock.md) | | [optional] +**result** | [**AddressBlock**](AddressBlock.md) | The created AddressBlock object. | [optional] ## Example diff --git a/src/ipam/docs/CreateAddressResponse.md b/src/ipam/docs/CreateAddressResponse.md index 6d89a92..60d99b6 100644 --- a/src/ipam/docs/CreateAddressResponse.md +++ b/src/ipam/docs/CreateAddressResponse.md @@ -6,7 +6,7 @@ The response format to create the __Address__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Address**](Address.md) | | [optional] +**result** | [**Address**](Address.md) | The created Address object. | [optional] ## Example diff --git a/src/ipam/docs/CreateFixedAddressResponse.md b/src/ipam/docs/CreateFixedAddressResponse.md index 5e3f7f8..441335f 100644 --- a/src/ipam/docs/CreateFixedAddressResponse.md +++ b/src/ipam/docs/CreateFixedAddressResponse.md @@ -6,7 +6,7 @@ The response format to create the __FixedAddress__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**FixedAddress**](FixedAddress.md) | | [optional] +**result** | [**FixedAddress**](FixedAddress.md) | The created Fixed Address object. | [optional] ## Example diff --git a/src/ipam/docs/CreateHAGroupResponse.md b/src/ipam/docs/CreateHAGroupResponse.md index a960745..e4aa744 100644 --- a/src/ipam/docs/CreateHAGroupResponse.md +++ b/src/ipam/docs/CreateHAGroupResponse.md @@ -6,7 +6,7 @@ The response format to create the __HAGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HAGroup**](HAGroup.md) | | [optional] +**result** | [**HAGroup**](HAGroup.md) | The created HAGroup object. | [optional] ## Example diff --git a/src/ipam/docs/CreateHardwareFilterResponse.md b/src/ipam/docs/CreateHardwareFilterResponse.md index 626c483..dd22475 100644 --- a/src/ipam/docs/CreateHardwareFilterResponse.md +++ b/src/ipam/docs/CreateHardwareFilterResponse.md @@ -6,7 +6,7 @@ The response format to create the __HardwareFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HardwareFilter**](HardwareFilter.md) | | [optional] +**result** | [**HardwareFilter**](HardwareFilter.md) | The created HardwareFilter object. | [optional] ## Example diff --git a/src/ipam/docs/CreateIPSpaceResponse.md b/src/ipam/docs/CreateIPSpaceResponse.md index 14da9a7..cc32589 100644 --- a/src/ipam/docs/CreateIPSpaceResponse.md +++ b/src/ipam/docs/CreateIPSpaceResponse.md @@ -6,7 +6,7 @@ The response format to create the __IPSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IPSpace**](IPSpace.md) | | [optional] +**result** | [**IPSpace**](IPSpace.md) | The created IP Space object. | [optional] ## Example diff --git a/src/ipam/docs/CreateIpamHostResponse.md b/src/ipam/docs/CreateIpamHostResponse.md index 84bae10..920db7a 100644 --- a/src/ipam/docs/CreateIpamHostResponse.md +++ b/src/ipam/docs/CreateIpamHostResponse.md @@ -6,7 +6,7 @@ The response format to create the __IpamHost__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IpamHost**](IpamHost.md) | | [optional] +**result** | [**IpamHost**](IpamHost.md) | The created IpamHost object. | [optional] ## Example diff --git a/src/ipam/docs/CreateOptionCodeResponse.md b/src/ipam/docs/CreateOptionCodeResponse.md index 242b353..109ebd2 100644 --- a/src/ipam/docs/CreateOptionCodeResponse.md +++ b/src/ipam/docs/CreateOptionCodeResponse.md @@ -6,7 +6,7 @@ The response format to create the __OptionCode__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionCode**](OptionCode.md) | | [optional] +**result** | [**OptionCode**](OptionCode.md) | The created OptionCode object. | [optional] ## Example diff --git a/src/ipam/docs/CreateOptionFilterResponse.md b/src/ipam/docs/CreateOptionFilterResponse.md index 9a3097c..b284741 100644 --- a/src/ipam/docs/CreateOptionFilterResponse.md +++ b/src/ipam/docs/CreateOptionFilterResponse.md @@ -6,7 +6,7 @@ The response format to create the __OptionFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionFilter**](OptionFilter.md) | | [optional] +**result** | [**OptionFilter**](OptionFilter.md) | The created OptionFilter object. | [optional] ## Example diff --git a/src/ipam/docs/CreateOptionGroupResponse.md b/src/ipam/docs/CreateOptionGroupResponse.md index 1ba6c19..92fcfb7 100644 --- a/src/ipam/docs/CreateOptionGroupResponse.md +++ b/src/ipam/docs/CreateOptionGroupResponse.md @@ -6,7 +6,7 @@ The response format to create the __OptionGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionGroup**](OptionGroup.md) | | [optional] +**result** | [**OptionGroup**](OptionGroup.md) | The created OptionGroup object. | [optional] ## Example diff --git a/src/ipam/docs/CreateOptionSpaceResponse.md b/src/ipam/docs/CreateOptionSpaceResponse.md index 4d91bf3..6c3a997 100644 --- a/src/ipam/docs/CreateOptionSpaceResponse.md +++ b/src/ipam/docs/CreateOptionSpaceResponse.md @@ -6,7 +6,7 @@ The response format to create the __OptionSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionSpace**](OptionSpace.md) | | [optional] +**result** | [**OptionSpace**](OptionSpace.md) | The created OptionSpace object. | [optional] ## Example diff --git a/src/ipam/docs/CreateRangeResponse.md b/src/ipam/docs/CreateRangeResponse.md index eb27f06..906762c 100644 --- a/src/ipam/docs/CreateRangeResponse.md +++ b/src/ipam/docs/CreateRangeResponse.md @@ -6,7 +6,7 @@ The response format to create the __Range__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Range**](Range.md) | | [optional] +**result** | [**Range**](Range.md) | The created Range object. | [optional] ## Example diff --git a/src/ipam/docs/CreateServerResponse.md b/src/ipam/docs/CreateServerResponse.md index 6a53535..6d72d34 100644 --- a/src/ipam/docs/CreateServerResponse.md +++ b/src/ipam/docs/CreateServerResponse.md @@ -6,7 +6,7 @@ The response format to create the __Server__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The created Server object. | [optional] ## Example diff --git a/src/ipam/docs/CreateSubnetResponse.md b/src/ipam/docs/CreateSubnetResponse.md index 3f69d39..8360a62 100644 --- a/src/ipam/docs/CreateSubnetResponse.md +++ b/src/ipam/docs/CreateSubnetResponse.md @@ -6,7 +6,7 @@ The response format to create the __Subnet__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Subnet**](Subnet.md) | | [optional] +**result** | [**Subnet**](Subnet.md) | The created Subnet object. | [optional] ## Example diff --git a/src/ipam/docs/DDNSZone.md b/src/ipam/docs/DDNSZone.md index 9c6fa0e..ee711fb 100644 --- a/src/ipam/docs/DDNSZone.md +++ b/src/ipam/docs/DDNSZone.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **gss_tsig_enabled** | **bool** | _gss_tsig_enabled_ enables/disables GSS-TSIG signed dynamic updates. Defaults to _false_. | [optional] **nameservers** | [**List[Nameserver]**](Nameserver.md) | The Nameservers in the zone. Each nameserver IP should be unique across the list of nameservers. | [optional] **tsig_enabled** | **bool** | Indicates if TSIG key should be used for the update. Defaults to _false_. | [optional] -**tsig_key** | [**TSIGKey**](TSIGKey.md) | | [optional] +**tsig_key** | [**TSIGKey**](TSIGKey.md) | The TSIG key. Required if _tsig_enabled_ is _true_. Defaults to empty. | [optional] **view** | **str** | The resource identifier. | [optional] **view_name** | **str** | The name of the view. | [optional] [readonly] **zone** | **str** | The resource identifier. | diff --git a/src/ipam/docs/DHCPGlobal.md b/src/ipam/docs/DHCPGlobal.md index 79749b7..32dca38 100644 --- a/src/ipam/docs/DHCPGlobal.md +++ b/src/ipam/docs/DHCPGlobal.md @@ -6,7 +6,7 @@ The global DHCP configuration (_dhcp/global_). Used by default unless more speci Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asm_config** | [**ASMConfig**](ASMConfig.md) | | [optional] +**asm_config** | [**ASMConfig**](ASMConfig.md) | The global Automated Scope Management configuration. | [optional] **client_principal** | **str** | The Kerberos principal name. It uses the typical Kerberos notation: <SERVICE-NAME>/<server-domain-name>@<REALM>. Defaults to empty. | [optional] **ddns_client_update** | **str** | The global configuration to control who does the DDNS updates. Valid values are: * _client_: DHCP server updates DNS if requested by client. * _server_: DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates. * _ignore_: DHCP server always updates DNS, even if the client says not to. * _over_client_update_: Same as _server_. DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates. * _over_no_update_: DHCP server updates DNS even if the client requests that no updates be done. If the client requests to do the update, DHCP server allows it. Defaults to _client_. | [optional] **ddns_conflict_resolution_mode** | **str** | The mode used for resolving conflicts while performing DDNS updates. Valid values are: * _check_with_dhcid_: It includes adding a DHCID record and checking that record via conflict detection as per RFC 4703. * _no_check_with_dhcid_: This will ignore conflict detection but add a DHCID record when creating/updating an entry. * _check_exists_with_dhcid_: This will check if there is an existing DHCID record but does not verify the value of the record matches the update. This will also update the DHCID record for the entry. * _no_check_without_dhcid_: This ignores conflict detection and will not add a DHCID record when creating/updating a DDNS entry. Defaults to _check_with_dhcid_. | [optional] @@ -19,10 +19,10 @@ Name | Type | Description | Notes **ddns_update_on_renew** | **bool** | Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed. Defaults to _false_. | [optional] **ddns_use_conflict_resolution** | **bool** | When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_. | [optional] **ddns_zones** | [**List[DDNSZone]**](DDNSZone.md) | DNS zones that DDNS updates can be sent to. There is no resolver fallback. The target zone must be explicitly configured for the update to be performed. Updates are sent to the closest enclosing zone. Error if _ddns_enabled_ is _true_ and the _ddns_domain_ does not have a corresponding entry in _ddns_zones_. Error if there are items with duplicate zone in the list. Defaults to empty list. | [optional] -**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | | [optional] +**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | The global DHCP configuration that controls how leases are issued. | [optional] **dhcp_options** | [**List[OptionItem]**](OptionItem.md) | The list of DHCP options or group of options for IPv4. An option list is ordered and may include both option groups and specific options. Multiple occurrences of the same option or group is not an error. The last occurrence of an option in the list will be used. Error if the graph of referenced groups contains cycles. Defaults to empty list. | [optional] **dhcp_options_v6** | [**List[OptionItem]**](OptionItem.md) | The list of DHCP options or group of options for IPv6. An option list is ordered and may include both option groups and specific options. Multiple occurrences of the same option or group is not an error. The last occurrence of an option in the list will be used. Error if the graph of referenced groups contains cycles. Defaults to empty list. | [optional] -**dhcp_threshold** | [**DHCPUtilizationThreshold**](DHCPUtilizationThreshold.md) | | [optional] +**dhcp_threshold** | [**DHCPUtilizationThreshold**](DHCPUtilizationThreshold.md) | The global DHCP Utilization threshold settings. | [optional] **gss_tsig_fallback** | **bool** | The behavior when GSS-TSIG should be used (a matching external DNS server is configured) but no GSS-TSIG key is available. If configured to _false_ (the default) this DNS server is skipped, if configured to _true_ the DNS server is ignored and the DNS update is sent with the configured DHCP-DDNS protection e.g. TSIG key or without any protection when none was configured. Defaults to _false_. | [optional] **header_option_filename** | **str** | The configuration for header option filename field. | [optional] **header_option_server_address** | **str** | The configuration for header option server address field. | [optional] diff --git a/src/ipam/docs/DHCPInheritance.md b/src/ipam/docs/DHCPInheritance.md index f63fece..31b93e4 100644 --- a/src/ipam/docs/DHCPInheritance.md +++ b/src/ipam/docs/DHCPInheritance.md @@ -6,21 +6,21 @@ The __DHCPInheritance__ object specifies how the _dhcp_config_, _dhcp_options_ a Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asm_config** | [**InheritedASMConfig**](InheritedASMConfig.md) | | [optional] -**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_enabled** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | | [optional] -**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | | [optional] -**ddns_update_block** | [**InheritedDDNSUpdateBlock**](InheritedDDNSUpdateBlock.md) | | [optional] -**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | | [optional] -**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | | [optional] +**asm_config** | [**InheritedASMConfig**](InheritedASMConfig.md) | The inheritance configuration for _asm_config_ field. | [optional] +**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_client_update_ field. | [optional] +**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_conflict_resolution_mode_ field. | [optional] +**ddns_enabled** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_enabled_ field. Only action allowed is 'inherit'. | [optional] +**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields. | [optional] +**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | The inheritance configuration for _ddns_ttl_percent_ field. | [optional] +**ddns_update_block** | [**InheritedDDNSUpdateBlock**](InheritedDDNSUpdateBlock.md) | The inheritance configuration for _ddns_send_updates_ and _ddns_domain_ fields. | [optional] +**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_update_on_renew_ field. | [optional] +**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_use_conflict_resolution_ field. | [optional] +**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | The inheritance configuration for _dhcp_config_ field. | [optional] +**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_ field. | [optional] +**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_filename_ field. | [optional] +**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_address_ field. | [optional] +**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_name_ field. | [optional] +**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, and _hostname_rewrite_char_ fields. | [optional] ## Example diff --git a/src/ipam/docs/DHCPOptionsInheritance.md b/src/ipam/docs/DHCPOptionsInheritance.md index 2018e63..524b2f5 100644 --- a/src/ipam/docs/DHCPOptionsInheritance.md +++ b/src/ipam/docs/DHCPOptionsInheritance.md @@ -6,7 +6,7 @@ The inheritance configuration that specifies how the _dhcp_options_ field is inh Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] +**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for the _dhcp_options_ field. | [optional] ## Example diff --git a/src/ipam/docs/FixedAddress.md b/src/ipam/docs/FixedAddress.md index ba0cc27..68c9266 100644 --- a/src/ipam/docs/FixedAddress.md +++ b/src/ipam/docs/FixedAddress.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_assigned_hosts** | [**List[InheritanceAssignedHost]**](InheritanceAssignedHost.md) | The list of the inheritance assigned hosts of the object. | [optional] [readonly] **inheritance_parent** | **str** | The resource identifier. | [optional] -**inheritance_sources** | [**FixedAddressInheritance**](FixedAddressInheritance.md) | | [optional] +**inheritance_sources** | [**FixedAddressInheritance**](FixedAddressInheritance.md) | The inheritance configuration. | [optional] **ip_space** | **str** | The resource identifier. | [optional] **match_type** | **str** | Indicates how to match the client: * _mac_: match the client MAC address for both IPv4 and IPv6, * _client_text_ or _client_hex_: match the client identifier for IPv4 only, * _relay_text_ or _relay_hex_: match the circuit ID or remote ID in the DHCP relay agent option (82) for IPv4 only, * _duid_: match the DHCP unique identifier, currently match only for IPv6 protocol. | **match_value** | **str** | The value to match. | diff --git a/src/ipam/docs/FixedAddressInheritance.md b/src/ipam/docs/FixedAddressInheritance.md index 9471b72..7ece9d1 100644 --- a/src/ipam/docs/FixedAddressInheritance.md +++ b/src/ipam/docs/FixedAddressInheritance.md @@ -6,10 +6,10 @@ The __FixedAddressInheritance__ object specifies how and which fields _FixedAddr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] +**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_ field. | [optional] +**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_filename_ field. | [optional] +**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_address_ field. | [optional] +**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_name_ field. | [optional] ## Example diff --git a/src/ipam/docs/Host.md b/src/ipam/docs/Host.md index 6048f44..62f47ed 100644 --- a/src/ipam/docs/Host.md +++ b/src/ipam/docs/Host.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **str** | The primary IP address of the on-prem host. | [optional] [readonly] **anycast_addresses** | **List[str]** | Anycast address configured to the host. Order is not significant. | [optional] [readonly] -**associated_server** | [**HostAssociatedServer**](HostAssociatedServer.md) | | [optional] +**associated_server** | [**HostAssociatedServer**](HostAssociatedServer.md) | The DHCP Config Profile for the on-prem host. | [optional] **comment** | **str** | The description for the on-prem host. | [optional] [readonly] **current_version** | **str** | Current dhcp application version of the host. | [optional] [readonly] **id** | **str** | The resource identifier. | [optional] [readonly] diff --git a/src/ipam/docs/HostAssociationsResponse.md b/src/ipam/docs/HostAssociationsResponse.md index 964d80b..5d89f1d 100644 --- a/src/ipam/docs/HostAssociationsResponse.md +++ b/src/ipam/docs/HostAssociationsResponse.md @@ -6,9 +6,9 @@ The response format to retrieve __HAGroup__, __Subnet__ and __DHCPPacketStats__ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dhcp_pkt_stats** | [**DHCPPacketStats**](DHCPPacketStats.md) | | [optional] +**dhcp_pkt_stats** | [**DHCPPacketStats**](DHCPPacketStats.md) | The DHCP packets statistics. | [optional] **ha_groups** | [**List[HAGroup]**](HAGroup.md) | The list of HA groups. | [optional] -**host** | [**Host**](Host.md) | | [optional] +**host** | [**Host**](Host.md) | The host for which the associated objects, subnets and HA groups, are returned. | [optional] **subnets** | [**List[Subnet]**](Subnet.md) | The list of subnets. | [optional] ## Example diff --git a/src/ipam/docs/IPSpace.md b/src/ipam/docs/IPSpace.md index 9c622af..3d3a267 100644 --- a/src/ipam/docs/IPSpace.md +++ b/src/ipam/docs/IPSpace.md @@ -6,7 +6,7 @@ An __IPSpace__ object (_ipam/ip_space_) allows customers to represent their enti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asm_config** | [**ASMConfig**](ASMConfig.md) | | [optional] +**asm_config** | [**ASMConfig**](ASMConfig.md) | The Automated Scope Management configuration for the IP space. | [optional] **asm_scope_flag** | **int** | The number of times the automated scope management usage limits have been exceeded for any of the subnets in this IP space. | [optional] [readonly] **comment** | **str** | The description for the IP space. May contain 0 to 1024 characters. Can include UTF-8. | [optional] **created_at** | **datetime** | Time when the object has been created. | [optional] [readonly] @@ -19,7 +19,7 @@ Name | Type | Description | Notes **ddns_ttl_percent** | **float** | DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75). Defaults to unspecified. | [optional] **ddns_update_on_renew** | **bool** | Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed. Defaults to _false_. | [optional] [default to False] **ddns_use_conflict_resolution** | **bool** | When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_. | [optional] [default to True] -**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | | [optional] +**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | The shared DHCP configuration for the IP space that controls how leases are issued. | [optional] **dhcp_options** | [**List[OptionItem]**](OptionItem.md) | The list of IPv4 DHCP options for IP space. May be either a specific option or a group of options. | [optional] **dhcp_options_v6** | [**List[OptionItem]**](OptionItem.md) | The list of IPv6 DHCP options for IP space. May be either a specific option or a group of options. | [optional] **header_option_filename** | **str** | The configuration for header option filename field. | [optional] @@ -29,13 +29,13 @@ Name | Type | Description | Notes **hostname_rewrite_enabled** | **bool** | Indicates if client supplied hostnames will be rewritten prior to DDNS update by replacing every character that does not match _hostname_rewrite_regex_ by _hostname_rewrite_char_. Defaults to _false_. | [optional] [default to False] **hostname_rewrite_regex** | **str** | The regex bracket expression to match valid characters. Must begin with \"[\" and end with \"]\" and be a compilable POSIX regex. Defaults to \"[^a-zA-Z0-9_.]\". | [optional] [default to '[^a-zA-Z0-9_.]'] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**IPSpaceInheritance**](IPSpaceInheritance.md) | | [optional] +**inheritance_sources** | [**IPSpaceInheritance**](IPSpaceInheritance.md) | The inheritance configuration. | [optional] **name** | **str** | The name of the IP space. Must contain 1 to 256 characters. Can include UTF-8. | **tags** | **object** | The tags for the IP space in JSON format. | [optional] -**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | | [optional] +**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | The utilization threshold settings for the IP space. | [optional] [readonly] **updated_at** | **datetime** | Time when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] -**utilization** | [**Utilization**](Utilization.md) | | [optional] -**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | | [optional] +**utilization** | [**Utilization**](Utilization.md) | The utilization of IPV4 addresses in the IP space. | [optional] [readonly] +**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | The utilization of IPV6 addresses in the IP space. | [optional] [readonly] **vendor_specific_option_option_space** | **str** | The resource identifier. | [optional] ## Example diff --git a/src/ipam/docs/IPSpaceInheritance.md b/src/ipam/docs/IPSpaceInheritance.md index bec5d24..38088e3 100644 --- a/src/ipam/docs/IPSpaceInheritance.md +++ b/src/ipam/docs/IPSpaceInheritance.md @@ -6,23 +6,23 @@ The __IPSpaceInheritance__ object specifies how and which fields _IPSpace_ objec Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asm_config** | [**InheritedASMConfig**](InheritedASMConfig.md) | | [optional] -**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_enabled** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | | [optional] -**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | | [optional] -**ddns_update_block** | [**InheritedDDNSUpdateBlock**](InheritedDDNSUpdateBlock.md) | | [optional] -**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | | [optional] -**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**dhcp_options_v6** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | | [optional] -**vendor_specific_option_option_space** | [**InheritanceInheritedIdentifier**](InheritanceInheritedIdentifier.md) | | [optional] +**asm_config** | [**InheritedASMConfig**](InheritedASMConfig.md) | The inheritance configuration for _asm_config_ field. | [optional] +**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_client_update_ field from _IPSpace_ object. | [optional] +**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_conflict_resolution_mode_ field from _IPSpace_ object. | [optional] +**ddns_enabled** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_enabled_ field. Only action allowed is 'inherit'. | [optional] +**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields from _IPSpace_ object. | [optional] +**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | The inheritance configuration for _ddns_ttl_percent_ field from _IPSpace_ object. | [optional] +**ddns_update_block** | [**InheritedDDNSUpdateBlock**](InheritedDDNSUpdateBlock.md) | The inheritance configuration for _ddns_send_updates_ and _ddns_domain_ fields from _IPSpace_ object. | [optional] +**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_update_on_renew_ field from _IPSpace_ object. | [optional] +**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_use_conflict_resolution_ field from _IPSpace_ object. | [optional] +**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | The inheritance configuration for _dhcp_config_ field. | [optional] +**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_ field. | [optional] +**dhcp_options_v6** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_v6_ field. | [optional] +**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_filename_ field. | [optional] +**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_address_ field. | [optional] +**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_name_ field. | [optional] +**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, and _hostname_rewrite_char_ fields from _IPSpace_ object. | [optional] +**vendor_specific_option_option_space** | [**InheritanceInheritedIdentifier**](InheritanceInheritedIdentifier.md) | The inheritance configuration for _vendor_specific_option_option_space_ field. | [optional] ## Example diff --git a/src/ipam/docs/InheritedASMConfig.md b/src/ipam/docs/InheritedASMConfig.md index 797a402..dd0054c 100644 --- a/src/ipam/docs/InheritedASMConfig.md +++ b/src/ipam/docs/InheritedASMConfig.md @@ -6,13 +6,13 @@ The inheritance configuration for the __ASMConfig__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asm_enable_block** | [**InheritedAsmEnableBlock**](InheritedAsmEnableBlock.md) | | [optional] -**asm_growth_block** | [**InheritedAsmGrowthBlock**](InheritedAsmGrowthBlock.md) | | [optional] -**asm_threshold** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**forecast_period** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**history** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**min_total** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**min_unused** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] +**asm_enable_block** | [**InheritedAsmEnableBlock**](InheritedAsmEnableBlock.md) | The block of ASM fields: _enable_, _enable_notification_, _reenable_date_. | [optional] +**asm_growth_block** | [**InheritedAsmGrowthBlock**](InheritedAsmGrowthBlock.md) | The block of ASM fields: _growth_factor_, _growth_type_. | [optional] +**asm_threshold** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | ASM shows the number of addresses forecast to be used _forecast_period_ days in the future, if it is greater than _asm_threshold_percent_ * _dhcp_total_ (see _dhcp_utilization_) then the subnet is flagged. | [optional] +**forecast_period** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The forecast period in days. | [optional] +**history** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The minimum amount of history needed before ASM can run on this subnet. | [optional] +**min_total** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The minimum size of range needed for ASM to run on this subnet. | [optional] +**min_unused** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change. | [optional] ## Example diff --git a/src/ipam/docs/InheritedAsmEnableBlock.md b/src/ipam/docs/InheritedAsmEnableBlock.md index 4d05a2a..8d8b68c 100644 --- a/src/ipam/docs/InheritedAsmEnableBlock.md +++ b/src/ipam/docs/InheritedAsmEnableBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**AsmEnableBlock**](AsmEnableBlock.md) | | [optional] +**value** | [**AsmEnableBlock**](AsmEnableBlock.md) | The inherited value. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/InheritedAsmGrowthBlock.md b/src/ipam/docs/InheritedAsmGrowthBlock.md index 72a1037..14f8712 100644 --- a/src/ipam/docs/InheritedAsmGrowthBlock.md +++ b/src/ipam/docs/InheritedAsmGrowthBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**AsmGrowthBlock**](AsmGrowthBlock.md) | | [optional] +**value** | [**AsmGrowthBlock**](AsmGrowthBlock.md) | The inherited value. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/InheritedDDNSBlock.md b/src/ipam/docs/InheritedDDNSBlock.md index b707681..07c9ea9 100644 --- a/src/ipam/docs/InheritedDDNSBlock.md +++ b/src/ipam/docs/InheritedDDNSBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**DDNSBlock**](DDNSBlock.md) | | [optional] +**value** | [**DDNSBlock**](DDNSBlock.md) | The inherited value. | [optional] ## Example diff --git a/src/ipam/docs/InheritedDDNSHostnameBlock.md b/src/ipam/docs/InheritedDDNSHostnameBlock.md index 8bc5f2e..1eb1c2b 100644 --- a/src/ipam/docs/InheritedDDNSHostnameBlock.md +++ b/src/ipam/docs/InheritedDDNSHostnameBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**DDNSHostnameBlock**](DDNSHostnameBlock.md) | | [optional] +**value** | [**DDNSHostnameBlock**](DDNSHostnameBlock.md) | The inherited value. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/InheritedDDNSUpdateBlock.md b/src/ipam/docs/InheritedDDNSUpdateBlock.md index e7b9ea0..9808c2c 100644 --- a/src/ipam/docs/InheritedDDNSUpdateBlock.md +++ b/src/ipam/docs/InheritedDDNSUpdateBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**DDNSUpdateBlock**](DDNSUpdateBlock.md) | | [optional] +**value** | [**DDNSUpdateBlock**](DDNSUpdateBlock.md) | The inherited value. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/InheritedDHCPConfig.md b/src/ipam/docs/InheritedDHCPConfig.md index 41b38f8..08af5d4 100644 --- a/src/ipam/docs/InheritedDHCPConfig.md +++ b/src/ipam/docs/InheritedDHCPConfig.md @@ -6,17 +6,17 @@ The inheritance configuration for a field of type _DHCPConfig_. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**abandoned_reclaim_time** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**abandoned_reclaim_time_v6** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**allow_unknown** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**allow_unknown_v6** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**echo_client_id** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**filters** | [**InheritedDHCPConfigFilterList**](InheritedDHCPConfigFilterList.md) | | [optional] -**filters_v6** | [**InheritedDHCPConfigFilterList**](InheritedDHCPConfigFilterList.md) | | [optional] -**ignore_client_uid** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ignore_list** | [**InheritedDHCPConfigIgnoreItemList**](InheritedDHCPConfigIgnoreItemList.md) | | [optional] -**lease_time** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] -**lease_time_v6** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | | [optional] +**abandoned_reclaim_time** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The inheritance configuration for _abandoned_reclaim_time_ field from _DHCPConfig_ object. | [optional] +**abandoned_reclaim_time_v6** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The inheritance configuration for _abandoned_reclaim_time_v6_ field from _DHCPConfig_ object. | [optional] +**allow_unknown** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _allow_unknown_ field from _DHCPConfig_ object. | [optional] +**allow_unknown_v6** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _allow_unknown_v6_ field from _DHCPConfig_ object. | [optional] +**echo_client_id** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _echo_client_id_ field from _DHCPConfig_ object. | [optional] +**filters** | [**InheritedDHCPConfigFilterList**](InheritedDHCPConfigFilterList.md) | The inheritance configuration for filters field from _DHCPConfig_ object. | [optional] +**filters_v6** | [**InheritedDHCPConfigFilterList**](InheritedDHCPConfigFilterList.md) | The inheritance configuration for _filters_v6_ field from _DHCPConfig_ object. | [optional] +**ignore_client_uid** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ignore_client_uid_ field from _DHCPConfig_ object. | [optional] +**ignore_list** | [**InheritedDHCPConfigIgnoreItemList**](InheritedDHCPConfigIgnoreItemList.md) | The inheritance configuration for _ignore_list_ field from _DHCPConfig_ object. | [optional] +**lease_time** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The inheritance configuration for _lease_time_ field from _DHCPConfig_ object. | [optional] +**lease_time_v6** | [**InheritanceInheritedUInt32**](InheritanceInheritedUInt32.md) | The inheritance configuration for _lease_time_v6_ field from _DHCPConfig_ object. | [optional] ## Example diff --git a/src/ipam/docs/InheritedDHCPOption.md b/src/ipam/docs/InheritedDHCPOption.md index 890c554..49cb7d9 100644 --- a/src/ipam/docs/InheritedDHCPOption.md +++ b/src/ipam/docs/InheritedDHCPOption.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _block_: Don't use the inherited value. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**InheritedDHCPOptionItem**](InheritedDHCPOptionItem.md) | | [optional] +**value** | [**InheritedDHCPOptionItem**](InheritedDHCPOptionItem.md) | The inherited value for the DHCP option. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/InheritedDHCPOptionItem.md b/src/ipam/docs/InheritedDHCPOptionItem.md index 3f43e09..3416133 100644 --- a/src/ipam/docs/InheritedDHCPOptionItem.md +++ b/src/ipam/docs/InheritedDHCPOptionItem.md @@ -6,7 +6,7 @@ A wrapper of item (_dhcp/option_item_) in a list of Inherited DHCP options. It c Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**option** | [**OptionItem**](OptionItem.md) | | [optional] +**option** | [**OptionItem**](OptionItem.md) | Option inherited from the ancestor. | [optional] **overriding_group** | **str** | The resource identifier. | [optional] ## Example diff --git a/src/ipam/docs/InheritedHostnameRewriteBlock.md b/src/ipam/docs/InheritedHostnameRewriteBlock.md index 65b7a93..6f87d42 100644 --- a/src/ipam/docs/InheritedHostnameRewriteBlock.md +++ b/src/ipam/docs/InheritedHostnameRewriteBlock.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **action** | **str** | The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | [optional] **display_name** | **str** | The human-readable display name for the object referred to by _source_. | [optional] [readonly] **source** | **str** | The resource identifier. | [optional] [readonly] -**value** | [**HostnameRewriteBlock**](HostnameRewriteBlock.md) | | [optional] +**value** | [**HostnameRewriteBlock**](HostnameRewriteBlock.md) | The inherited value. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/OptionFilter.md b/src/ipam/docs/OptionFilter.md index e4a8b8c..02cd187 100644 --- a/src/ipam/docs/OptionFilter.md +++ b/src/ipam/docs/OptionFilter.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **name** | **str** | The name of the option filter. Must contain 1 to 256 characters. Can include UTF-8. | **protocol** | **str** | The type of protocol of option filter (_ip4_ or _ip6_). | [optional] **role** | **str** | The role of DHCP filter (_values_ or _selection_). Defaults to _values_. | [optional] -**rules** | [**OptionFilterRuleList**](OptionFilterRuleList.md) | | +**rules** | [**OptionFilterRuleList**](OptionFilterRuleList.md) | The list of option filter rules to match. | **tags** | **object** | The tags for the option filter in JSON format. | [optional] **updated_at** | **datetime** | Time when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] **vendor_specific_option_option_space** | **str** | The resource identifier. | [optional] diff --git a/src/ipam/docs/Range.md b/src/ipam/docs/Range.md index 447ebc0..54cdb6c 100644 --- a/src/ipam/docs/Range.md +++ b/src/ipam/docs/Range.md @@ -17,17 +17,17 @@ Name | Type | Description | Notes **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_assigned_hosts** | [**List[InheritanceAssignedHost]**](InheritanceAssignedHost.md) | The list of the inheritance assigned hosts of the object. | [optional] [readonly] **inheritance_parent** | **str** | The resource identifier. | [optional] -**inheritance_sources** | [**DHCPOptionsInheritance**](DHCPOptionsInheritance.md) | | [optional] +**inheritance_sources** | [**DHCPOptionsInheritance**](DHCPOptionsInheritance.md) | The DHCP inheritance configuration for the range. | [optional] **name** | **str** | The name of the range. May contain 1 to 256 characters. Can include UTF-8. | [optional] **parent** | **str** | The resource identifier. | [optional] **protocol** | **str** | The type of protocol (_ip4_ or _ip6_). | [optional] [readonly] **space** | **str** | The resource identifier. | [optional] **start** | **str** | The start IP address of the range. | **tags** | **object** | The tags for the range in JSON format. | [optional] -**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | | [optional] +**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | The utilization threshold settings for the range. | [optional] **updated_at** | **datetime** | Time when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] -**utilization** | [**Utilization**](Utilization.md) | | [optional] -**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | | [optional] +**utilization** | [**Utilization**](Utilization.md) | The utilization statistics of IPV4 addresses for the range. | [optional] [readonly] +**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | The utilization of IPV6 addresses in the range. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/ReadASMResponse.md b/src/ipam/docs/ReadASMResponse.md index 99f6b38..9c366c2 100644 --- a/src/ipam/docs/ReadASMResponse.md +++ b/src/ipam/docs/ReadASMResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __ASM__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**ASM**](ASM.md) | | [optional] +**result** | [**ASM**](ASM.md) | The ASM object. | [optional] ## Example diff --git a/src/ipam/docs/ReadAddressBlockResponse.md b/src/ipam/docs/ReadAddressBlockResponse.md index 909e2ed..9b51f36 100644 --- a/src/ipam/docs/ReadAddressBlockResponse.md +++ b/src/ipam/docs/ReadAddressBlockResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __AddressBlock__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AddressBlock**](AddressBlock.md) | | [optional] +**result** | [**AddressBlock**](AddressBlock.md) | The AddressBlock object. | [optional] ## Example diff --git a/src/ipam/docs/ReadAddressResponse.md b/src/ipam/docs/ReadAddressResponse.md index 8cec71f..0c8abae 100644 --- a/src/ipam/docs/ReadAddressResponse.md +++ b/src/ipam/docs/ReadAddressResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Address__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Address**](Address.md) | | [optional] +**result** | [**Address**](Address.md) | The Address object. | [optional] ## Example diff --git a/src/ipam/docs/ReadDNSUsageResponse.md b/src/ipam/docs/ReadDNSUsageResponse.md index f2c36b4..1283e8d 100644 --- a/src/ipam/docs/ReadDNSUsageResponse.md +++ b/src/ipam/docs/ReadDNSUsageResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __DNSUsage__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**DNSUsage**](DNSUsage.md) | | [optional] +**result** | [**DNSUsage**](DNSUsage.md) | The DNSUsage object. | [optional] ## Example diff --git a/src/ipam/docs/ReadFixedAddressResponse.md b/src/ipam/docs/ReadFixedAddressResponse.md index c78d139..4b8a7ee 100644 --- a/src/ipam/docs/ReadFixedAddressResponse.md +++ b/src/ipam/docs/ReadFixedAddressResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __FixedAddress__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**FixedAddress**](FixedAddress.md) | | [optional] +**result** | [**FixedAddress**](FixedAddress.md) | The FixedAddress object. | [optional] ## Example diff --git a/src/ipam/docs/ReadGlobalResponse.md b/src/ipam/docs/ReadGlobalResponse.md index 8667cc9..5800d32 100644 --- a/src/ipam/docs/ReadGlobalResponse.md +++ b/src/ipam/docs/ReadGlobalResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Global__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**DHCPGlobal**](DHCPGlobal.md) | | [optional] +**result** | [**DHCPGlobal**](DHCPGlobal.md) | The Global object. | [optional] ## Example diff --git a/src/ipam/docs/ReadHAGroupResponse.md b/src/ipam/docs/ReadHAGroupResponse.md index bdd4033..5ac3da6 100644 --- a/src/ipam/docs/ReadHAGroupResponse.md +++ b/src/ipam/docs/ReadHAGroupResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __HAGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HAGroup**](HAGroup.md) | | [optional] +**result** | [**HAGroup**](HAGroup.md) | The HAGroup object. | [optional] ## Example diff --git a/src/ipam/docs/ReadHardwareFilterResponse.md b/src/ipam/docs/ReadHardwareFilterResponse.md index b8e37c9..a6bdc1e 100644 --- a/src/ipam/docs/ReadHardwareFilterResponse.md +++ b/src/ipam/docs/ReadHardwareFilterResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __HardwareFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HardwareFilter**](HardwareFilter.md) | | [optional] +**result** | [**HardwareFilter**](HardwareFilter.md) | The HardwareFilter object. | [optional] ## Example diff --git a/src/ipam/docs/ReadHostResponse.md b/src/ipam/docs/ReadHostResponse.md index 2a856e9..4d1cc1c 100644 --- a/src/ipam/docs/ReadHostResponse.md +++ b/src/ipam/docs/ReadHostResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the DHCP __Host__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Host**](Host.md) | | [optional] +**result** | [**Host**](Host.md) | The DHCP Host object. | [optional] ## Example diff --git a/src/ipam/docs/ReadIPSpaceResponse.md b/src/ipam/docs/ReadIPSpaceResponse.md index ef6d69e..2146f28 100644 --- a/src/ipam/docs/ReadIPSpaceResponse.md +++ b/src/ipam/docs/ReadIPSpaceResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __IPSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IPSpace**](IPSpace.md) | | [optional] +**result** | [**IPSpace**](IPSpace.md) | The IPSpace object. | [optional] ## Example diff --git a/src/ipam/docs/ReadIpamHostResponse.md b/src/ipam/docs/ReadIpamHostResponse.md index 8e40f41..0aeb373 100644 --- a/src/ipam/docs/ReadIpamHostResponse.md +++ b/src/ipam/docs/ReadIpamHostResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __IpamHost__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IpamHost**](IpamHost.md) | | [optional] +**result** | [**IpamHost**](IpamHost.md) | The IpamHost object. | [optional] ## Example diff --git a/src/ipam/docs/ReadOptionCodeResponse.md b/src/ipam/docs/ReadOptionCodeResponse.md index 8b7f802..85c128e 100644 --- a/src/ipam/docs/ReadOptionCodeResponse.md +++ b/src/ipam/docs/ReadOptionCodeResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __OptionCode__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionCode**](OptionCode.md) | | [optional] +**result** | [**OptionCode**](OptionCode.md) | The OptionCode object. | [optional] ## Example diff --git a/src/ipam/docs/ReadOptionFilterResponse.md b/src/ipam/docs/ReadOptionFilterResponse.md index 5699865..96bb20e 100644 --- a/src/ipam/docs/ReadOptionFilterResponse.md +++ b/src/ipam/docs/ReadOptionFilterResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __OptionFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionFilter**](OptionFilter.md) | | [optional] +**result** | [**OptionFilter**](OptionFilter.md) | The OptionFilter object. | [optional] ## Example diff --git a/src/ipam/docs/ReadOptionGroupResponse.md b/src/ipam/docs/ReadOptionGroupResponse.md index 992c9ee..a4f4b55 100644 --- a/src/ipam/docs/ReadOptionGroupResponse.md +++ b/src/ipam/docs/ReadOptionGroupResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __OptionGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionGroup**](OptionGroup.md) | | [optional] +**result** | [**OptionGroup**](OptionGroup.md) | The OptionGroup object. | [optional] ## Example diff --git a/src/ipam/docs/ReadOptionSpaceResponse.md b/src/ipam/docs/ReadOptionSpaceResponse.md index 3ecfa4c..69afc6f 100644 --- a/src/ipam/docs/ReadOptionSpaceResponse.md +++ b/src/ipam/docs/ReadOptionSpaceResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __OptionSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionSpace**](OptionSpace.md) | | [optional] +**result** | [**OptionSpace**](OptionSpace.md) | The OptionSpace object. | [optional] ## Example diff --git a/src/ipam/docs/ReadRangeResponse.md b/src/ipam/docs/ReadRangeResponse.md index 76e380f..ebf7b55 100644 --- a/src/ipam/docs/ReadRangeResponse.md +++ b/src/ipam/docs/ReadRangeResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Range__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Range**](Range.md) | | [optional] +**result** | [**Range**](Range.md) | The Range object. | [optional] ## Example diff --git a/src/ipam/docs/ReadServerResponse.md b/src/ipam/docs/ReadServerResponse.md index 75aa417..bd00472 100644 --- a/src/ipam/docs/ReadServerResponse.md +++ b/src/ipam/docs/ReadServerResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Server__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The Server object. | [optional] ## Example diff --git a/src/ipam/docs/ReadSubnetResponse.md b/src/ipam/docs/ReadSubnetResponse.md index 15c726f..334686b 100644 --- a/src/ipam/docs/ReadSubnetResponse.md +++ b/src/ipam/docs/ReadSubnetResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __Subnet__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Subnet**](Subnet.md) | | [optional] +**result** | [**Subnet**](Subnet.md) | The Subnet object. | [optional] ## Example diff --git a/src/ipam/docs/Server.md b/src/ipam/docs/Server.md index 50d4308..41fa347 100644 --- a/src/ipam/docs/Server.md +++ b/src/ipam/docs/Server.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **ddns_update_on_renew** | **bool** | Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed. Defaults to _false_. | [optional] **ddns_use_conflict_resolution** | **bool** | When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_. | [optional] **ddns_zones** | [**List[DDNSZone]**](DDNSZone.md) | The DNS zones that DDNS updates can be sent to. There is no resolver fallback. The target zone must be explicitly configured for the update to be performed. Updates are sent to the closest enclosing zone. Error if _ddns_enabled_ is _true_ and the _ddns_domain_ does not have a corresponding entry in _ddns_zones_. Error if there are items with duplicate zone in the list. Defaults to empty list. | [optional] -**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | | [optional] +**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | The DHCP configuration for the profile. This controls how leases are issued. | [optional] **dhcp_options** | [**List[OptionItem]**](OptionItem.md) | The list of DHCP options or group of options for IPv4. An option list is ordered and may include both option groups and specific options. Multiple occurences of the same option or group is not an error. The last occurence of an option in the list will be used. Error if the graph of referenced groups contains cycles. Defaults to empty list. | [optional] **dhcp_options_v6** | [**List[OptionItem]**](OptionItem.md) | The list of DHCP options or group of options for IPv6. An option list is ordered and may include both option groups and specific options. Multiple occurences of the same option or group is not an error. The last occurence of an option in the list will be used. Error if the graph of referenced groups contains cycles. Defaults to empty list. | [optional] **gss_tsig_fallback** | **bool** | The behavior when GSS-TSIG should be used (a matching external DNS server is configured) but no GSS-TSIG key is available. If configured to _false_ (the default) this DNS server is skipped, if configured to _true_ the DNS server is ignored and the DNS update is sent with the configured DHCP-DDNS protection e.g. TSIG key or without any protection when none was configured. Defaults to _false_. | [optional] @@ -31,7 +31,7 @@ Name | Type | Description | Notes **hostname_rewrite_enabled** | **bool** | Indicates if client supplied hostnames will be rewritten prior to DDNS update by replacing every character that does not match _hostname_rewrite_regex_ by _hostname_rewrite_char_. Defaults to _false_. | [optional] **hostname_rewrite_regex** | **str** | The regex bracket expression to match valid characters. Must begin with \"[\" and end with \"]\" and be a compilable POSIX regex. Defaults to \"[^a-zA-Z0-9_.]\". | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] -**inheritance_sources** | [**ServerInheritance**](ServerInheritance.md) | | [optional] +**inheritance_sources** | [**ServerInheritance**](ServerInheritance.md) | The inheritance configuration. | [optional] **kerberos_kdc** | **str** | Address of Kerberos Key Distribution Center. Defaults to empty. | [optional] **kerberos_keys** | [**List[KerberosKey]**](KerberosKey.md) | _kerberos_keys_ contains a list of keys for GSS-TSIG signed dynamic updates. Defaults to empty. | [optional] **kerberos_rekey_interval** | **int** | Time interval (in seconds) the keys for each configured external DNS server are checked for rekeying, i.e. a new key is created to replace the current usable one when its age is greater than the _kerberos_rekey_interval_ value. Defaults to 120 seconds. | [optional] diff --git a/src/ipam/docs/ServerInheritance.md b/src/ipam/docs/ServerInheritance.md index fba0fc0..f7c86f6 100644 --- a/src/ipam/docs/ServerInheritance.md +++ b/src/ipam/docs/ServerInheritance.md @@ -6,21 +6,21 @@ The inheritance configuration specifies how and which fields _Server_ object (DH Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ddns_block** | [**InheritedDDNSBlock**](InheritedDDNSBlock.md) | | [optional] -**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | | [optional] -**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | | [optional] -**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | | [optional] -**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | | [optional] -**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**dhcp_options_v6** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | | [optional] -**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | | [optional] -**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | | [optional] -**vendor_specific_option_option_space** | [**InheritanceInheritedIdentifier**](InheritanceInheritedIdentifier.md) | | [optional] +**ddns_block** | [**InheritedDDNSBlock**](InheritedDDNSBlock.md) | The inheritance configuration for _ddns_enabled_, _ddns_send_updates_, _ddns_domain_, _ddns_zones_ fields from _Server_ object. | [optional] +**ddns_client_update** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_client_update_ field from _Server_ object. | [optional] +**ddns_conflict_resolution_mode** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _ddns_conflict_resolution_mode_ field from _Server_ object. | [optional] +**ddns_hostname_block** | [**InheritedDDNSHostnameBlock**](InheritedDDNSHostnameBlock.md) | The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields from _Server_ object. | [optional] +**ddns_ttl_percent** | [**InheritanceInheritedFloat**](InheritanceInheritedFloat.md) | The inheritance configuration for _ddns_ttl_percent_ field from _Server_ object. | [optional] +**ddns_update_on_renew** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_update_on_renew_ field from _Server_ object. | [optional] +**ddns_use_conflict_resolution** | [**InheritanceInheritedBool**](InheritanceInheritedBool.md) | The inheritance configuration for _ddns_use_conflict_resolution_ field from _Server_ object. | [optional] +**dhcp_config** | [**InheritedDHCPConfig**](InheritedDHCPConfig.md) | The inheritance configuration for _dhcp_config_ field from _Server_ object. | [optional] +**dhcp_options** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_ field from _Server_ object. | [optional] +**dhcp_options_v6** | [**InheritedDHCPOptionList**](InheritedDHCPOptionList.md) | The inheritance configuration for _dhcp_options_v6_ field from _Server_ object. | [optional] +**header_option_filename** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_filename_ field. | [optional] +**header_option_server_address** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_address_ field. | [optional] +**header_option_server_name** | [**InheritanceInheritedString**](InheritanceInheritedString.md) | The inheritance configuration for _header_option_server_name_ field. | [optional] +**hostname_rewrite_block** | [**InheritedHostnameRewriteBlock**](InheritedHostnameRewriteBlock.md) | The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, _hostname_rewrite_char_ fields from _Server_ object. | [optional] +**vendor_specific_option_option_space** | [**InheritanceInheritedIdentifier**](InheritanceInheritedIdentifier.md) | The inheritance configuration for _vendor_specific_option_option_space_ field from _Server_ object. | [optional] ## Example diff --git a/src/ipam/docs/Subnet.md b/src/ipam/docs/Subnet.md index c0abb08..d0e3fbd 100644 --- a/src/ipam/docs/Subnet.md +++ b/src/ipam/docs/Subnet.md @@ -7,7 +7,7 @@ A __Subnet__ object (_ipam/subnet_) is a set of contiguous IP addresses in the s Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **str** | The address of the subnet in the form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the _cidr_ field. When reading, the _address_ field is always in the form “a.b.c.d”. | [optional] -**asm_config** | [**ASMConfig**](ASMConfig.md) | | [optional] +**asm_config** | [**ASMConfig**](ASMConfig.md) | The Automated Scope Management configuration for the subnet. | [optional] **asm_scope_flag** | **int** | Set to 1 to indicate that the subnet may run out of addresses. | [optional] [readonly] **cidr** | **int** | The CIDR of the subnet. This is required if _address_ does not include CIDR. | [optional] **comment** | **str** | The description for the subnet. May contain 0 to 1024 characters. Can include UTF-8. | [optional] @@ -21,10 +21,10 @@ Name | Type | Description | Notes **ddns_ttl_percent** | **float** | DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75). Defaults to unspecified. | [optional] **ddns_update_on_renew** | **bool** | Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed. Defaults to _false_. | [optional] **ddns_use_conflict_resolution** | **bool** | When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_. | [optional] -**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | | [optional] +**dhcp_config** | [**DHCPConfig**](DHCPConfig.md) | The DHCP configuration of the subnet that controls how leases are issued. | [optional] **dhcp_host** | **str** | The resource identifier. | [optional] **dhcp_options** | [**List[OptionItem]**](OptionItem.md) | The DHCP options of the subnet. This can either be a specific option or a group of options. | [optional] -**dhcp_utilization** | [**DHCPUtilization**](DHCPUtilization.md) | | [optional] +**dhcp_utilization** | [**DHCPUtilization**](DHCPUtilization.md) | The utilization of IP addresses within the DHCP ranges of the subnet. | [optional] [readonly] **disable_dhcp** | **bool** | Optional. _true_ to disable object. A disabled object is effectively non-existent when generating configuration. Defaults to _false_. | [optional] **discovery_attrs** | **object** | The discovery attributes for this subnet in JSON format. | [optional] [readonly] **discovery_metadata** | **object** | The discovery metadata for this subnet in JSON format. | [optional] [readonly] @@ -37,7 +37,7 @@ Name | Type | Description | Notes **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_assigned_hosts** | [**List[InheritanceAssignedHost]**](InheritanceAssignedHost.md) | The list of the inheritance assigned hosts of the object. | [optional] [readonly] **inheritance_parent** | **str** | The resource identifier. | [optional] -**inheritance_sources** | [**DHCPInheritance**](DHCPInheritance.md) | | [optional] +**inheritance_sources** | [**DHCPInheritance**](DHCPInheritance.md) | The DHCP inheritance configuration for the subnet. | [optional] **name** | **str** | The name of the subnet. May contain 1 to 256 characters. Can include UTF-8. | [optional] **parent** | **str** | The resource identifier. | [optional] **protocol** | **str** | The type of protocol of the subnet (_ip4_ or _ip6_). | [optional] [readonly] @@ -45,11 +45,11 @@ Name | Type | Description | Notes **renew_time** | **int** | The lease renew time (T1) in seconds. | [optional] **space** | **str** | The resource identifier. | [optional] **tags** | **object** | The tags for the subnet in JSON format. | [optional] -**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | | [optional] +**threshold** | [**UtilizationThreshold**](UtilizationThreshold.md) | The IP address utilization threshold settings for the subnet. | [optional] **updated_at** | **datetime** | Time when the object has been updated. Equals to _created_at_ if not updated after creation. | [optional] [readonly] **usage** | **List[str]** | The usage is a combination of indicators, each tracking a specific associated use. Listed below are usage indicators with their meaning: usage indicator | description ---------------------- | -------------------------------- _IPAM_ | Subnet is managed in BloxOne DDI. _DHCP_ | Subnet is served by a DHCP Host. _DISCOVERED_ | Subnet is discovered by some network discovery probe like Network Insight or NetMRI in NIOS. | [optional] [readonly] -**utilization** | [**Utilization**](Utilization.md) | | [optional] -**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | | [optional] +**utilization** | [**Utilization**](Utilization.md) | The IPV4 address utilization statistics of the subnet. | [optional] [readonly] +**utilization_v6** | [**UtilizationV6**](UtilizationV6.md) | The utilization of IPV6 addresses in the subnet. | [optional] [readonly] ## Example diff --git a/src/ipam/docs/UpdateAddressBlockResponse.md b/src/ipam/docs/UpdateAddressBlockResponse.md index 20499ce..9fca9cb 100644 --- a/src/ipam/docs/UpdateAddressBlockResponse.md +++ b/src/ipam/docs/UpdateAddressBlockResponse.md @@ -6,7 +6,7 @@ The response format to update the __AddressBlock__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**AddressBlock**](AddressBlock.md) | | [optional] +**result** | [**AddressBlock**](AddressBlock.md) | The AddressBlock object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateAddressResponse.md b/src/ipam/docs/UpdateAddressResponse.md index 805bd89..5eb057b 100644 --- a/src/ipam/docs/UpdateAddressResponse.md +++ b/src/ipam/docs/UpdateAddressResponse.md @@ -6,7 +6,7 @@ The response format to update the __Address__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Address**](Address.md) | | [optional] +**result** | [**Address**](Address.md) | The Address object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateFixedAddressResponse.md b/src/ipam/docs/UpdateFixedAddressResponse.md index e3204c4..8c24c31 100644 --- a/src/ipam/docs/UpdateFixedAddressResponse.md +++ b/src/ipam/docs/UpdateFixedAddressResponse.md @@ -6,7 +6,7 @@ The response format to update the __FixedAddress__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**FixedAddress**](FixedAddress.md) | | [optional] +**result** | [**FixedAddress**](FixedAddress.md) | The FixedAddress object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateGlobalResponse.md b/src/ipam/docs/UpdateGlobalResponse.md index 561ff8e..40ba849 100644 --- a/src/ipam/docs/UpdateGlobalResponse.md +++ b/src/ipam/docs/UpdateGlobalResponse.md @@ -6,7 +6,7 @@ The response format to update the __Global__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**DHCPGlobal**](DHCPGlobal.md) | | [optional] +**result** | [**DHCPGlobal**](DHCPGlobal.md) | The Global object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateHAGroupResponse.md b/src/ipam/docs/UpdateHAGroupResponse.md index aebf787..a9f78e4 100644 --- a/src/ipam/docs/UpdateHAGroupResponse.md +++ b/src/ipam/docs/UpdateHAGroupResponse.md @@ -6,7 +6,7 @@ The response format to update the __HAGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HAGroup**](HAGroup.md) | | [optional] +**result** | [**HAGroup**](HAGroup.md) | The HAGroup object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateHardwareFilterResponse.md b/src/ipam/docs/UpdateHardwareFilterResponse.md index 450a543..b6fa9af 100644 --- a/src/ipam/docs/UpdateHardwareFilterResponse.md +++ b/src/ipam/docs/UpdateHardwareFilterResponse.md @@ -6,7 +6,7 @@ The response format to update the __HardwareFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**HardwareFilter**](HardwareFilter.md) | | [optional] +**result** | [**HardwareFilter**](HardwareFilter.md) | The HardwareFilter object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateHostResponse.md b/src/ipam/docs/UpdateHostResponse.md index 861d591..3c9696e 100644 --- a/src/ipam/docs/UpdateHostResponse.md +++ b/src/ipam/docs/UpdateHostResponse.md @@ -6,7 +6,7 @@ The response format to update the DHCP __Host__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Host**](Host.md) | | [optional] +**result** | [**Host**](Host.md) | The DHCP Host object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateIPSpaceResponse.md b/src/ipam/docs/UpdateIPSpaceResponse.md index 75a9335..aad2f9c 100644 --- a/src/ipam/docs/UpdateIPSpaceResponse.md +++ b/src/ipam/docs/UpdateIPSpaceResponse.md @@ -6,7 +6,7 @@ The response format to update the __IPSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IPSpace**](IPSpace.md) | | [optional] +**result** | [**IPSpace**](IPSpace.md) | The IPSpace object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateIpamHostResponse.md b/src/ipam/docs/UpdateIpamHostResponse.md index 61c622b..85985cf 100644 --- a/src/ipam/docs/UpdateIpamHostResponse.md +++ b/src/ipam/docs/UpdateIpamHostResponse.md @@ -6,7 +6,7 @@ The response format to update the _IpamHost__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**IpamHost**](IpamHost.md) | | [optional] +**result** | [**IpamHost**](IpamHost.md) | The IpamHost object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateOptionCodeResponse.md b/src/ipam/docs/UpdateOptionCodeResponse.md index b623172..e25c4ef 100644 --- a/src/ipam/docs/UpdateOptionCodeResponse.md +++ b/src/ipam/docs/UpdateOptionCodeResponse.md @@ -6,7 +6,7 @@ The response format to update the __OptionCode__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionCode**](OptionCode.md) | | [optional] +**result** | [**OptionCode**](OptionCode.md) | The OptionCode object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateOptionFilterResponse.md b/src/ipam/docs/UpdateOptionFilterResponse.md index 59116fc..a72ff05 100644 --- a/src/ipam/docs/UpdateOptionFilterResponse.md +++ b/src/ipam/docs/UpdateOptionFilterResponse.md @@ -6,7 +6,7 @@ The response format to update the __OptionFilter__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionFilter**](OptionFilter.md) | | [optional] +**result** | [**OptionFilter**](OptionFilter.md) | The OptionFilter object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateOptionGroupResponse.md b/src/ipam/docs/UpdateOptionGroupResponse.md index b81f4ff..f4148a9 100644 --- a/src/ipam/docs/UpdateOptionGroupResponse.md +++ b/src/ipam/docs/UpdateOptionGroupResponse.md @@ -6,7 +6,7 @@ The response format to update the __OptionGroup__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionGroup**](OptionGroup.md) | | [optional] +**result** | [**OptionGroup**](OptionGroup.md) | The OptionGroup object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateOptionSpaceResponse.md b/src/ipam/docs/UpdateOptionSpaceResponse.md index 12eb0d1..084b04f 100644 --- a/src/ipam/docs/UpdateOptionSpaceResponse.md +++ b/src/ipam/docs/UpdateOptionSpaceResponse.md @@ -6,7 +6,7 @@ The response format to update the __OptionSpace__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**OptionSpace**](OptionSpace.md) | | [optional] +**result** | [**OptionSpace**](OptionSpace.md) | The OptionSpace object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateRangeResponse.md b/src/ipam/docs/UpdateRangeResponse.md index 9d9dcd8..f44edd3 100644 --- a/src/ipam/docs/UpdateRangeResponse.md +++ b/src/ipam/docs/UpdateRangeResponse.md @@ -6,7 +6,7 @@ The response format to update the __Range__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Range**](Range.md) | | [optional] +**result** | [**Range**](Range.md) | The Range object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateServerResponse.md b/src/ipam/docs/UpdateServerResponse.md index 5f4f101..8178bbd 100644 --- a/src/ipam/docs/UpdateServerResponse.md +++ b/src/ipam/docs/UpdateServerResponse.md @@ -6,7 +6,7 @@ The response format to update the __Server__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Server**](Server.md) | | [optional] +**result** | [**Server**](Server.md) | The Server object. | [optional] ## Example diff --git a/src/ipam/docs/UpdateSubnetResponse.md b/src/ipam/docs/UpdateSubnetResponse.md index 79cfc51..73d84be 100644 --- a/src/ipam/docs/UpdateSubnetResponse.md +++ b/src/ipam/docs/UpdateSubnetResponse.md @@ -6,7 +6,7 @@ The response format to update the __Subnet__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**Subnet**](Subnet.md) | | [optional] +**result** | [**Subnet**](Subnet.md) | The Subnet object. | [optional] ## Example diff --git a/src/ipam/models/address.py b/src/ipam/models/address.py index 3a4d5a8..7d1becb 100644 --- a/src/ipam/models/address.py +++ b/src/ipam/models/address.py @@ -37,7 +37,9 @@ class Address(BaseModel): ) created_at: Optional[datetime] = Field( default=None, description="Time when the object has been created.") - dhcp_info: Optional[DHCPInfo] = None + dhcp_info: Optional[DHCPInfo] = Field( + default=None, + description="The DHCP information associated with this object.") disable_dhcp: Optional[StrictBool] = Field( default=None, description= @@ -134,10 +136,12 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "created_at", + "dhcp_info", "disable_dhcp", "discovery_attrs", "discovery_metadata", diff --git a/src/ipam/models/address_block.py b/src/ipam/models/address_block.py index 42190db..419d0cf 100644 --- a/src/ipam/models/address_block.py +++ b/src/ipam/models/address_block.py @@ -41,7 +41,10 @@ class AddressBlock(BaseModel): description= "The address field in form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the _cidr_ field. When reading, the _address_ field is always in the form “a.b.c.d”." ) - asm_config: Optional[ASMConfig] = None + asm_config: Optional[ASMConfig] = Field( + default=None, + description= + "The Automated Scope Management configuration for the address block.") asm_scope_flag: Optional[StrictInt] = Field( default=None, description= @@ -104,13 +107,21 @@ class AddressBlock(BaseModel): description= "When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_." ) - dhcp_config: Optional[DHCPConfig] = None + dhcp_config: Optional[DHCPConfig] = Field( + default=None, + description= + "The shared DHCP configuration that controls how leases are issued for the address block." + ) dhcp_options: Optional[List[OptionItem]] = Field( default=None, description= "The list of DHCP options for the address block. May be either a specific option or a group of options." ) - dhcp_utilization: Optional[DHCPUtilization] = None + dhcp_utilization: Optional[DHCPUtilization] = Field( + default=None, + description= + "The utilization of IP addresses within the DHCP ranges of the address block." + ) discovery_attrs: Optional[Dict[str, Any]] = Field( default=None, description= @@ -148,7 +159,10 @@ class AddressBlock(BaseModel): description="The resource identifier.") inheritance_parent: Optional[StrictStr] = Field( default=None, description="The resource identifier.") - inheritance_sources: Optional[DHCPInheritance] = None + inheritance_sources: Optional[DHCPInheritance] = Field( + default=None, + description="The DHCP inheritance configuration for the address block." + ) name: Optional[StrictStr] = Field( default=None, description= @@ -164,7 +178,10 @@ class AddressBlock(BaseModel): tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for the address block in JSON format.") - threshold: Optional[UtilizationThreshold] = None + threshold: Optional[UtilizationThreshold] = Field( + default=None, + description= + "The IP address utilization thresholds for the address block.") updated_at: Optional[datetime] = Field( default=None, description= @@ -175,8 +192,13 @@ class AddressBlock(BaseModel): description= "The usage is a combination of indicators, each tracking a specific associated use. Listed below are usage indicators with their meaning: usage indicator | description ---------------------- | -------------------------------- _IPAM_ | AddressBlock is managed in BloxOne DDI. _DISCOVERED_ | AddressBlock is discovered by some network discovery probe like Network Insight or NetMRI in NIOS." ) - utilization: Optional[Utilization] = None - utilization_v6: Optional[UtilizationV6] = None + utilization: Optional[Utilization] = Field( + default=None, + description= + "The IPV4 address utilization statistics for the address block.") + utilization_v6: Optional[UtilizationV6] = Field( + default=None, + description="The utilization of IPV6 addresses in the Address block.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "address", "asm_config", "asm_scope_flag", "cidr", "comment", @@ -230,17 +252,23 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "asm_scope_flag", "created_at", + "dhcp_utilization", "discovery_attrs", "discovery_metadata", "id", "protocol", "updated_at", "usage", + "utilization", + "utilization_v6", "additional_properties", ]) diff --git a/src/ipam/models/create_address_block_response.py b/src/ipam/models/create_address_block_response.py index b514225..fd81b68 100644 --- a/src/ipam/models/create_address_block_response.py +++ b/src/ipam/models/create_address_block_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address_block import AddressBlock from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateAddressBlockResponse(BaseModel): """ The response format to create the __AddressBlock__ object. """ # noqa: E501 - result: Optional[AddressBlock] = None + result: Optional[AddressBlock] = Field( + default=None, description="The created AddressBlock object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_address_response.py b/src/ipam/models/create_address_response.py index 11b10bd..514de94 100644 --- a/src/ipam/models/create_address_response.py +++ b/src/ipam/models/create_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address import Address from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateAddressResponse(BaseModel): """ The response format to create the __Address__ object. """ # noqa: E501 - result: Optional[Address] = None + result: Optional[Address] = Field( + default=None, description="The created Address object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_asm_response.py b/src/ipam/models/create_asm_response.py index 4af292a..21b7df3 100644 --- a/src/ipam/models/create_asm_response.py +++ b/src/ipam/models/create_asm_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.asm import ASM from typing import Optional, Set @@ -27,7 +27,7 @@ class CreateASMResponse(BaseModel): """ The response format to update subnet and range for ASM. """ # noqa: E501 - result: Optional[ASM] = None + result: Optional[ASM] = Field(default=None, description="The ASM object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_fixed_address_response.py b/src/ipam/models/create_fixed_address_response.py index aaaa234..8b74b98 100644 --- a/src/ipam/models/create_fixed_address_response.py +++ b/src/ipam/models/create_fixed_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.fixed_address import FixedAddress from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateFixedAddressResponse(BaseModel): """ The response format to create the __FixedAddress__ object. """ # noqa: E501 - result: Optional[FixedAddress] = None + result: Optional[FixedAddress] = Field( + default=None, description="The created Fixed Address object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_ha_group_response.py b/src/ipam/models/create_ha_group_response.py index 1a4487e..30d5f34 100644 --- a/src/ipam/models/create_ha_group_response.py +++ b/src/ipam/models/create_ha_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ha_group import HAGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateHAGroupResponse(BaseModel): """ The response format to create the __HAGroup__ object. """ # noqa: E501 - result: Optional[HAGroup] = None + result: Optional[HAGroup] = Field( + default=None, description="The created HAGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_hardware_filter_response.py b/src/ipam/models/create_hardware_filter_response.py index 1aec673..2a876d6 100644 --- a/src/ipam/models/create_hardware_filter_response.py +++ b/src/ipam/models/create_hardware_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.hardware_filter import HardwareFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateHardwareFilterResponse(BaseModel): """ The response format to create the __HardwareFilter__ object. """ # noqa: E501 - result: Optional[HardwareFilter] = None + result: Optional[HardwareFilter] = Field( + default=None, description="The created HardwareFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_ip_space_response.py b/src/ipam/models/create_ip_space_response.py index 470a019..1d91476 100644 --- a/src/ipam/models/create_ip_space_response.py +++ b/src/ipam/models/create_ip_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ip_space import IPSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateIPSpaceResponse(BaseModel): """ The response format to create the __IPSpace__ object. """ # noqa: E501 - result: Optional[IPSpace] = None + result: Optional[IPSpace] = Field( + default=None, description="The created IP Space object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_ipam_host_response.py b/src/ipam/models/create_ipam_host_response.py index 335f6e3..075a8e4 100644 --- a/src/ipam/models/create_ipam_host_response.py +++ b/src/ipam/models/create_ipam_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ipam_host import IpamHost from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateIpamHostResponse(BaseModel): """ The response format to create the __IpamHost__ object. """ # noqa: E501 - result: Optional[IpamHost] = None + result: Optional[IpamHost] = Field( + default=None, description="The created IpamHost object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_option_code_response.py b/src/ipam/models/create_option_code_response.py index 2f988c7..dfb8280 100644 --- a/src/ipam/models/create_option_code_response.py +++ b/src/ipam/models/create_option_code_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_code import OptionCode from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateOptionCodeResponse(BaseModel): """ The response format to create the __OptionCode__ object. """ # noqa: E501 - result: Optional[OptionCode] = None + result: Optional[OptionCode] = Field( + default=None, description="The created OptionCode object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_option_filter_response.py b/src/ipam/models/create_option_filter_response.py index f7a6286..46188f0 100644 --- a/src/ipam/models/create_option_filter_response.py +++ b/src/ipam/models/create_option_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_filter import OptionFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateOptionFilterResponse(BaseModel): """ The response format to create the __OptionFilter__ object. """ # noqa: E501 - result: Optional[OptionFilter] = None + result: Optional[OptionFilter] = Field( + default=None, description="The created OptionFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_option_group_response.py b/src/ipam/models/create_option_group_response.py index 0075576..e0b4d05 100644 --- a/src/ipam/models/create_option_group_response.py +++ b/src/ipam/models/create_option_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_group import OptionGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateOptionGroupResponse(BaseModel): """ The response format to create the __OptionGroup__ object. """ # noqa: E501 - result: Optional[OptionGroup] = None + result: Optional[OptionGroup] = Field( + default=None, description="The created OptionGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_option_space_response.py b/src/ipam/models/create_option_space_response.py index 6a948f9..7967156 100644 --- a/src/ipam/models/create_option_space_response.py +++ b/src/ipam/models/create_option_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_space import OptionSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateOptionSpaceResponse(BaseModel): """ The response format to create the __OptionSpace__ object. """ # noqa: E501 - result: Optional[OptionSpace] = None + result: Optional[OptionSpace] = Field( + default=None, description="The created OptionSpace object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_range_response.py b/src/ipam/models/create_range_response.py index 9ef4a43..c018278 100644 --- a/src/ipam/models/create_range_response.py +++ b/src/ipam/models/create_range_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.range import Range from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateRangeResponse(BaseModel): """ The response format to create the __Range__ object. """ # noqa: E501 - result: Optional[Range] = None + result: Optional[Range] = Field(default=None, + description="The created Range object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_server_response.py b/src/ipam/models/create_server_response.py index 2d142e9..74b665d 100644 --- a/src/ipam/models/create_server_response.py +++ b/src/ipam/models/create_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.server import Server from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateServerResponse(BaseModel): """ The response format to create the __Server__ object. """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The created Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/create_subnet_response.py b/src/ipam/models/create_subnet_response.py index 5fc5a03..c723dcc 100644 --- a/src/ipam/models/create_subnet_response.py +++ b/src/ipam/models/create_subnet_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.subnet import Subnet from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateSubnetResponse(BaseModel): """ The response format to create the __Subnet__ object. """ # noqa: E501 - result: Optional[Subnet] = None + result: Optional[Subnet] = Field(default=None, + description="The created Subnet object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/ddns_zone.py b/src/ipam/models/ddns_zone.py index 3b0394f..9ec2634 100644 --- a/src/ipam/models/ddns_zone.py +++ b/src/ipam/models/ddns_zone.py @@ -47,7 +47,11 @@ class DDNSZone(BaseModel): description= "Indicates if TSIG key should be used for the update. Defaults to _false_." ) - tsig_key: Optional[TSIGKey] = None + tsig_key: Optional[TSIGKey] = Field( + default=None, + description= + "The TSIG key. Required if _tsig_enabled_ is _true_. Defaults to empty." + ) view: Optional[StrictStr] = Field(default=None, description="The resource identifier.") view_name: Optional[StrictStr] = Field(default=None, diff --git a/src/ipam/models/dhcp_global.py b/src/ipam/models/dhcp_global.py index 41b7946..9e80381 100644 --- a/src/ipam/models/dhcp_global.py +++ b/src/ipam/models/dhcp_global.py @@ -32,7 +32,9 @@ class DHCPGlobal(BaseModel): """ The global DHCP configuration (_dhcp/global_). Used by default unless more specific configuration exists. There is only one instance of this object. """ # noqa: E501 - asm_config: Optional[ASMConfig] = None + asm_config: Optional[ASMConfig] = Field( + default=None, + description="The global Automated Scope Management configuration.") client_principal: Optional[StrictStr] = Field( default=None, description= @@ -93,7 +95,10 @@ class DHCPGlobal(BaseModel): description= "DNS zones that DDNS updates can be sent to. There is no resolver fallback. The target zone must be explicitly configured for the update to be performed. Updates are sent to the closest enclosing zone. Error if _ddns_enabled_ is _true_ and the _ddns_domain_ does not have a corresponding entry in _ddns_zones_. Error if there are items with duplicate zone in the list. Defaults to empty list." ) - dhcp_config: Optional[DHCPConfig] = None + dhcp_config: Optional[DHCPConfig] = Field( + default=None, + description= + "The global DHCP configuration that controls how leases are issued.") dhcp_options: Optional[List[OptionItem]] = Field( default=None, description= @@ -104,7 +109,9 @@ class DHCPGlobal(BaseModel): description= "The list of DHCP options or group of options for IPv6. An option list is ordered and may include both option groups and specific options. Multiple occurrences of the same option or group is not an error. The last occurrence of an option in the list will be used. Error if the graph of referenced groups contains cycles. Defaults to empty list." ) - dhcp_threshold: Optional[DHCPUtilizationThreshold] = None + dhcp_threshold: Optional[DHCPUtilizationThreshold] = Field( + default=None, + description="The global DHCP Utilization threshold settings.") gss_tsig_fallback: Optional[StrictBool] = Field( default=None, description= diff --git a/src/ipam/models/dhcp_inheritance.py b/src/ipam/models/dhcp_inheritance.py index f46df86..7a6acbf 100644 --- a/src/ipam/models/dhcp_inheritance.py +++ b/src/ipam/models/dhcp_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_bool import InheritanceInheritedBool from ipam.models.inheritance_inherited_float import InheritanceInheritedFloat @@ -35,21 +35,70 @@ class DHCPInheritance(BaseModel): """ The __DHCPInheritance__ object specifies how the _dhcp_config_, _dhcp_options_ and _asm_config_ configuration fields are inherited from the parent object. """ # noqa: E501 - asm_config: Optional[InheritedASMConfig] = None - ddns_client_update: Optional[InheritanceInheritedString] = None - ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = None - ddns_enabled: Optional[InheritanceInheritedBool] = None - ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = None - ddns_ttl_percent: Optional[InheritanceInheritedFloat] = None - ddns_update_block: Optional[InheritedDDNSUpdateBlock] = None - ddns_update_on_renew: Optional[InheritanceInheritedBool] = None - ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = None - dhcp_config: Optional[InheritedDHCPConfig] = None - dhcp_options: Optional[InheritedDHCPOptionList] = None - header_option_filename: Optional[InheritanceInheritedString] = None - header_option_server_address: Optional[InheritanceInheritedString] = None - header_option_server_name: Optional[InheritanceInheritedString] = None - hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = None + asm_config: Optional[InheritedASMConfig] = Field( + default=None, + description="The inheritance configuration for _asm_config_ field.") + ddns_client_update: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_client_update_ field.") + ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_conflict_resolution_mode_ field." + ) + ddns_enabled: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_enabled_ field. Only action allowed is 'inherit'." + ) + ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields." + ) + ddns_ttl_percent: Optional[InheritanceInheritedFloat] = Field( + default=None, + description= + "The inheritance configuration for _ddns_ttl_percent_ field.") + ddns_update_block: Optional[InheritedDDNSUpdateBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_send_updates_ and _ddns_domain_ fields." + ) + ddns_update_on_renew: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_update_on_renew_ field.") + ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_use_conflict_resolution_ field." + ) + dhcp_config: Optional[InheritedDHCPConfig] = Field( + default=None, + description="The inheritance configuration for _dhcp_config_ field.") + dhcp_options: Optional[InheritedDHCPOptionList] = Field( + default=None, + description="The inheritance configuration for _dhcp_options_ field.") + header_option_filename: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_filename_ field.") + header_option_server_address: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_address_ field." + ) + header_option_server_name: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_name_ field.") + hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = Field( + default=None, + description= + "The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, and _hostname_rewrite_char_ fields." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "asm_config", "ddns_client_update", "ddns_conflict_resolution_mode", diff --git a/src/ipam/models/dhcp_options_inheritance.py b/src/ipam/models/dhcp_options_inheritance.py index 1dc2044..f777613 100644 --- a/src/ipam/models/dhcp_options_inheritance.py +++ b/src/ipam/models/dhcp_options_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inherited_dhcp_option_list import InheritedDHCPOptionList from typing import Optional, Set @@ -27,7 +27,10 @@ class DHCPOptionsInheritance(BaseModel): """ The inheritance configuration that specifies how the _dhcp_options_ field is inherited from the parent object. """ # noqa: E501 - dhcp_options: Optional[InheritedDHCPOptionList] = None + dhcp_options: Optional[InheritedDHCPOptionList] = Field( + default=None, + description= + "The inheritance configuration for the _dhcp_options_ field.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["dhcp_options"] diff --git a/src/ipam/models/fixed_address.py b/src/ipam/models/fixed_address.py index ccf3ee5..4b4f408 100644 --- a/src/ipam/models/fixed_address.py +++ b/src/ipam/models/fixed_address.py @@ -71,7 +71,8 @@ class FixedAddress(BaseModel): ) inheritance_parent: Optional[StrictStr] = Field( default=None, description="The resource identifier.") - inheritance_sources: Optional[FixedAddressInheritance] = None + inheritance_sources: Optional[FixedAddressInheritance] = Field( + default=None, description="The inheritance configuration.") ip_space: Optional[StrictStr] = Field( default=None, description="The resource identifier.") match_type: StrictStr = Field( diff --git a/src/ipam/models/fixed_address_inheritance.py b/src/ipam/models/fixed_address_inheritance.py index 94c4641..685bedb 100644 --- a/src/ipam/models/fixed_address_inheritance.py +++ b/src/ipam/models/fixed_address_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_string import InheritanceInheritedString from ipam.models.inherited_dhcp_option_list import InheritedDHCPOptionList @@ -28,10 +28,22 @@ class FixedAddressInheritance(BaseModel): """ The __FixedAddressInheritance__ object specifies how and which fields _FixedAddress_ object inherits from the parent. """ # noqa: E501 - dhcp_options: Optional[InheritedDHCPOptionList] = None - header_option_filename: Optional[InheritanceInheritedString] = None - header_option_server_address: Optional[InheritanceInheritedString] = None - header_option_server_name: Optional[InheritanceInheritedString] = None + dhcp_options: Optional[InheritedDHCPOptionList] = Field( + default=None, + description="The inheritance configuration for _dhcp_options_ field.") + header_option_filename: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_filename_ field.") + header_option_server_address: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_address_ field." + ) + header_option_server_name: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_name_ field.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "dhcp_options", "header_option_filename", diff --git a/src/ipam/models/host.py b/src/ipam/models/host.py index f3c3e58..d731f46 100644 --- a/src/ipam/models/host.py +++ b/src/ipam/models/host.py @@ -34,7 +34,9 @@ class Host(BaseModel): default=None, description= "Anycast address configured to the host. Order is not significant.") - associated_server: Optional[HostAssociatedServer] = None + associated_server: Optional[HostAssociatedServer] = Field( + default=None, + description="The DHCP Config Profile for the on-prem host.") comment: Optional[StrictStr] = Field( default=None, description="The description for the on-prem host.") current_version: Optional[StrictStr] = Field( diff --git a/src/ipam/models/host_associations_response.py b/src/ipam/models/host_associations_response.py index 6896d2c..a3fdfe9 100644 --- a/src/ipam/models/host_associations_response.py +++ b/src/ipam/models/host_associations_response.py @@ -30,10 +30,15 @@ class HostAssociationsResponse(BaseModel): """ The response format to retrieve __HAGroup__, __Subnet__ and __DHCPPacketStats__ objects associated with the DHCP __Host__ object. The host in question is also included in the output, for the convenience reasons. """ # noqa: E501 - dhcp_pkt_stats: Optional[DHCPPacketStats] = None + dhcp_pkt_stats: Optional[DHCPPacketStats] = Field( + default=None, description="The DHCP packets statistics.") ha_groups: Optional[List[HAGroup]] = Field( default=None, description="The list of HA groups.") - host: Optional[Host] = None + host: Optional[Host] = Field( + default=None, + description= + "The host for which the associated objects, subnets and HA groups, are returned." + ) subnets: Optional[List[Subnet]] = Field(default=None, description="The list of subnets.") additional_properties: Dict[str, Any] = {} diff --git a/src/ipam/models/inherited_asm_config.py b/src/ipam/models/inherited_asm_config.py index 577de89..4db7bf2 100644 --- a/src/ipam/models/inherited_asm_config.py +++ b/src/ipam/models/inherited_asm_config.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_u_int32 import InheritanceInheritedUInt32 from ipam.models.inherited_asm_enable_block import InheritedAsmEnableBlock @@ -29,13 +29,35 @@ class InheritedASMConfig(BaseModel): """ The inheritance configuration for the __ASMConfig__ object. """ # noqa: E501 - asm_enable_block: Optional[InheritedAsmEnableBlock] = None - asm_growth_block: Optional[InheritedAsmGrowthBlock] = None - asm_threshold: Optional[InheritanceInheritedUInt32] = None - forecast_period: Optional[InheritanceInheritedUInt32] = None - history: Optional[InheritanceInheritedUInt32] = None - min_total: Optional[InheritanceInheritedUInt32] = None - min_unused: Optional[InheritanceInheritedUInt32] = None + asm_enable_block: Optional[InheritedAsmEnableBlock] = Field( + default=None, + description= + "The block of ASM fields: _enable_, _enable_notification_, _reenable_date_." + ) + asm_growth_block: Optional[InheritedAsmGrowthBlock] = Field( + default=None, + description="The block of ASM fields: _growth_factor_, _growth_type_.") + asm_threshold: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "ASM shows the number of addresses forecast to be used _forecast_period_ days in the future, if it is greater than _asm_threshold_percent_ * _dhcp_total_ (see _dhcp_utilization_) then the subnet is flagged." + ) + forecast_period: Optional[InheritanceInheritedUInt32] = Field( + default=None, description="The forecast period in days.") + history: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The minimum amount of history needed before ASM can run on this subnet." + ) + min_total: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The minimum size of range needed for ASM to run on this subnet.") + min_unused: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "asm_enable_block", "asm_growth_block", "asm_threshold", diff --git a/src/ipam/models/inherited_asm_enable_block.py b/src/ipam/models/inherited_asm_enable_block.py index 0395800..ed6fd59 100644 --- a/src/ipam/models/inherited_asm_enable_block.py +++ b/src/ipam/models/inherited_asm_enable_block.py @@ -39,7 +39,8 @@ class InheritedAsmEnableBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[AsmEnableBlock] = None + value: Optional[AsmEnableBlock] = Field(default=None, + description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/inherited_asm_growth_block.py b/src/ipam/models/inherited_asm_growth_block.py index 345b4e1..f9d23f0 100644 --- a/src/ipam/models/inherited_asm_growth_block.py +++ b/src/ipam/models/inherited_asm_growth_block.py @@ -39,7 +39,8 @@ class InheritedAsmGrowthBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[AsmGrowthBlock] = None + value: Optional[AsmGrowthBlock] = Field(default=None, + description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/inherited_ddns_block.py b/src/ipam/models/inherited_ddns_block.py index 883060a..161821e 100644 --- a/src/ipam/models/inherited_ddns_block.py +++ b/src/ipam/models/inherited_ddns_block.py @@ -39,7 +39,8 @@ class InheritedDDNSBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[DDNSBlock] = None + value: Optional[DDNSBlock] = Field(default=None, + description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" diff --git a/src/ipam/models/inherited_ddns_hostname_block.py b/src/ipam/models/inherited_ddns_hostname_block.py index 1ed470c..e22d4fc 100644 --- a/src/ipam/models/inherited_ddns_hostname_block.py +++ b/src/ipam/models/inherited_ddns_hostname_block.py @@ -39,7 +39,8 @@ class InheritedDDNSHostnameBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[DDNSHostnameBlock] = None + value: Optional[DDNSHostnameBlock] = Field( + default=None, description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/inherited_ddns_update_block.py b/src/ipam/models/inherited_ddns_update_block.py index 9064719..b042956 100644 --- a/src/ipam/models/inherited_ddns_update_block.py +++ b/src/ipam/models/inherited_ddns_update_block.py @@ -39,7 +39,8 @@ class InheritedDDNSUpdateBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[DDNSUpdateBlock] = None + value: Optional[DDNSUpdateBlock] = Field( + default=None, description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/inherited_dhcp_config.py b/src/ipam/models/inherited_dhcp_config.py index 033995b..8b2197b 100644 --- a/src/ipam/models/inherited_dhcp_config.py +++ b/src/ipam/models/inherited_dhcp_config.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_bool import InheritanceInheritedBool from ipam.models.inheritance_inherited_u_int32 import InheritanceInheritedUInt32 @@ -30,17 +30,61 @@ class InheritedDHCPConfig(BaseModel): """ The inheritance configuration for a field of type _DHCPConfig_. """ # noqa: E501 - abandoned_reclaim_time: Optional[InheritanceInheritedUInt32] = None - abandoned_reclaim_time_v6: Optional[InheritanceInheritedUInt32] = None - allow_unknown: Optional[InheritanceInheritedBool] = None - allow_unknown_v6: Optional[InheritanceInheritedBool] = None - echo_client_id: Optional[InheritanceInheritedBool] = None - filters: Optional[InheritedDHCPConfigFilterList] = None - filters_v6: Optional[InheritedDHCPConfigFilterList] = None - ignore_client_uid: Optional[InheritanceInheritedBool] = None - ignore_list: Optional[InheritedDHCPConfigIgnoreItemList] = None - lease_time: Optional[InheritanceInheritedUInt32] = None - lease_time_v6: Optional[InheritanceInheritedUInt32] = None + abandoned_reclaim_time: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The inheritance configuration for _abandoned_reclaim_time_ field from _DHCPConfig_ object." + ) + abandoned_reclaim_time_v6: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The inheritance configuration for _abandoned_reclaim_time_v6_ field from _DHCPConfig_ object." + ) + allow_unknown: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _allow_unknown_ field from _DHCPConfig_ object." + ) + allow_unknown_v6: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _allow_unknown_v6_ field from _DHCPConfig_ object." + ) + echo_client_id: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _echo_client_id_ field from _DHCPConfig_ object." + ) + filters: Optional[InheritedDHCPConfigFilterList] = Field( + default=None, + description= + "The inheritance configuration for filters field from _DHCPConfig_ object." + ) + filters_v6: Optional[InheritedDHCPConfigFilterList] = Field( + default=None, + description= + "The inheritance configuration for _filters_v6_ field from _DHCPConfig_ object." + ) + ignore_client_uid: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ignore_client_uid_ field from _DHCPConfig_ object." + ) + ignore_list: Optional[InheritedDHCPConfigIgnoreItemList] = Field( + default=None, + description= + "The inheritance configuration for _ignore_list_ field from _DHCPConfig_ object." + ) + lease_time: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The inheritance configuration for _lease_time_ field from _DHCPConfig_ object." + ) + lease_time_v6: Optional[InheritanceInheritedUInt32] = Field( + default=None, + description= + "The inheritance configuration for _lease_time_v6_ field from _DHCPConfig_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "abandoned_reclaim_time", "abandoned_reclaim_time_v6", "allow_unknown", diff --git a/src/ipam/models/inherited_dhcp_option.py b/src/ipam/models/inherited_dhcp_option.py index a348239..2156ddb 100644 --- a/src/ipam/models/inherited_dhcp_option.py +++ b/src/ipam/models/inherited_dhcp_option.py @@ -39,7 +39,8 @@ class InheritedDHCPOption(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[InheritedDHCPOptionItem] = None + value: Optional[InheritedDHCPOptionItem] = Field( + default=None, description="The inherited value for the DHCP option.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/inherited_dhcp_option_item.py b/src/ipam/models/inherited_dhcp_option_item.py index 0821065..eb250aa 100644 --- a/src/ipam/models/inherited_dhcp_option_item.py +++ b/src/ipam/models/inherited_dhcp_option_item.py @@ -27,7 +27,8 @@ class InheritedDHCPOptionItem(BaseModel): """ A wrapper of item (_dhcp/option_item_) in a list of Inherited DHCP options. It contains extra fields not covered by OptionItem. """ # noqa: E501 - option: Optional[OptionItem] = None + option: Optional[OptionItem] = Field( + default=None, description="Option inherited from the ancestor.") overriding_group: Optional[StrictStr] = Field( default=None, description="The resource identifier.") additional_properties: Dict[str, Any] = {} diff --git a/src/ipam/models/inherited_hostname_rewrite_block.py b/src/ipam/models/inherited_hostname_rewrite_block.py index dac8419..56601a6 100644 --- a/src/ipam/models/inherited_hostname_rewrite_block.py +++ b/src/ipam/models/inherited_hostname_rewrite_block.py @@ -39,7 +39,8 @@ class InheritedHostnameRewriteBlock(BaseModel): ) source: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - value: Optional[HostnameRewriteBlock] = None + value: Optional[HostnameRewriteBlock] = Field( + default=None, description="The inherited value.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "action", "display_name", "source", "value" @@ -76,11 +77,13 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "display_name", "source", + "value", "additional_properties", ]) diff --git a/src/ipam/models/ip_space.py b/src/ipam/models/ip_space.py index d811c83..3cc49a9 100644 --- a/src/ipam/models/ip_space.py +++ b/src/ipam/models/ip_space.py @@ -34,7 +34,10 @@ class IPSpace(BaseModel): """ An __IPSpace__ object (_ipam/ip_space_) allows customers to represent their entire managed address space with no collision. A collision arises when two or more block of addresses overlap partially or fully. """ # noqa: E501 - asm_config: Optional[ASMConfig] = None + asm_config: Optional[ASMConfig] = Field( + default=None, + description= + "The Automated Scope Management configuration for the IP space.") asm_scope_flag: Optional[StrictInt] = Field( default=None, description= @@ -92,7 +95,11 @@ class IPSpace(BaseModel): description= "When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_." ) - dhcp_config: Optional[DHCPConfig] = None + dhcp_config: Optional[DHCPConfig] = Field( + default=None, + description= + "The shared DHCP configuration for the IP space that controls how leases are issued." + ) dhcp_options: Optional[List[OptionItem]] = Field( default=None, description= @@ -130,21 +137,28 @@ class IPSpace(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[IPSpaceInheritance] = None + inheritance_sources: Optional[IPSpaceInheritance] = Field( + default=None, description="The inheritance configuration.") name: StrictStr = Field( description= "The name of the IP space. Must contain 1 to 256 characters. Can include UTF-8." ) tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for the IP space in JSON format.") - threshold: Optional[UtilizationThreshold] = None + threshold: Optional[UtilizationThreshold] = Field( + default=None, + description="The utilization threshold settings for the IP space.") updated_at: Optional[datetime] = Field( default=None, description= "Time when the object has been updated. Equals to _created_at_ if not updated after creation." ) - utilization: Optional[Utilization] = None - utilization_v6: Optional[UtilizationV6] = None + utilization: Optional[Utilization] = Field( + default=None, + description="The utilization of IPV4 addresses in the IP space.") + utilization_v6: Optional[UtilizationV6] = Field( + default=None, + description="The utilization of IPV6 addresses in the IP space.") vendor_specific_option_option_space: Optional[StrictStr] = Field( default=None, description="The resource identifier.") additional_properties: Dict[str, Any] = {} @@ -195,13 +209,19 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "asm_scope_flag", "created_at", "id", + "threshold", "updated_at", + "utilization", + "utilization_v6", "additional_properties", ]) diff --git a/src/ipam/models/ip_space_inheritance.py b/src/ipam/models/ip_space_inheritance.py index d7d2c32..b403a1f 100644 --- a/src/ipam/models/ip_space_inheritance.py +++ b/src/ipam/models/ip_space_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_bool import InheritanceInheritedBool from ipam.models.inheritance_inherited_float import InheritanceInheritedFloat @@ -36,24 +36,83 @@ class IPSpaceInheritance(BaseModel): """ The __IPSpaceInheritance__ object specifies how and which fields _IPSpace_ object inherits from the parent. """ # noqa: E501 - asm_config: Optional[InheritedASMConfig] = None - ddns_client_update: Optional[InheritanceInheritedString] = None - ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = None - ddns_enabled: Optional[InheritanceInheritedBool] = None - ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = None - ddns_ttl_percent: Optional[InheritanceInheritedFloat] = None - ddns_update_block: Optional[InheritedDDNSUpdateBlock] = None - ddns_update_on_renew: Optional[InheritanceInheritedBool] = None - ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = None - dhcp_config: Optional[InheritedDHCPConfig] = None - dhcp_options: Optional[InheritedDHCPOptionList] = None - dhcp_options_v6: Optional[InheritedDHCPOptionList] = None - header_option_filename: Optional[InheritanceInheritedString] = None - header_option_server_address: Optional[InheritanceInheritedString] = None - header_option_server_name: Optional[InheritanceInheritedString] = None - hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = None + asm_config: Optional[InheritedASMConfig] = Field( + default=None, + description="The inheritance configuration for _asm_config_ field.") + ddns_client_update: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_client_update_ field from _IPSpace_ object." + ) + ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_conflict_resolution_mode_ field from _IPSpace_ object." + ) + ddns_enabled: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_enabled_ field. Only action allowed is 'inherit'." + ) + ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields from _IPSpace_ object." + ) + ddns_ttl_percent: Optional[InheritanceInheritedFloat] = Field( + default=None, + description= + "The inheritance configuration for _ddns_ttl_percent_ field from _IPSpace_ object." + ) + ddns_update_block: Optional[InheritedDDNSUpdateBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_send_updates_ and _ddns_domain_ fields from _IPSpace_ object." + ) + ddns_update_on_renew: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_update_on_renew_ field from _IPSpace_ object." + ) + ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_use_conflict_resolution_ field from _IPSpace_ object." + ) + dhcp_config: Optional[InheritedDHCPConfig] = Field( + default=None, + description="The inheritance configuration for _dhcp_config_ field.") + dhcp_options: Optional[InheritedDHCPOptionList] = Field( + default=None, + description="The inheritance configuration for _dhcp_options_ field.") + dhcp_options_v6: Optional[InheritedDHCPOptionList] = Field( + default=None, + description="The inheritance configuration for _dhcp_options_v6_ field." + ) + header_option_filename: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_filename_ field.") + header_option_server_address: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_address_ field." + ) + header_option_server_name: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_name_ field.") + hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = Field( + default=None, + description= + "The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, and _hostname_rewrite_char_ fields from _IPSpace_ object." + ) vendor_specific_option_option_space: Optional[ - InheritanceInheritedIdentifier] = None + InheritanceInheritedIdentifier] = Field( + default=None, + description= + "The inheritance configuration for _vendor_specific_option_option_space_ field." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "asm_config", "ddns_client_update", "ddns_conflict_resolution_mode", diff --git a/src/ipam/models/option_filter.py b/src/ipam/models/option_filter.py index b90abaa..01c6dd9 100644 --- a/src/ipam/models/option_filter.py +++ b/src/ipam/models/option_filter.py @@ -67,7 +67,8 @@ class OptionFilter(BaseModel): description= "The role of DHCP filter (_values_ or _selection_). Defaults to _values_." ) - rules: OptionFilterRuleList + rules: OptionFilterRuleList = Field( + description="The list of option filter rules to match.") tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for the option filter in JSON format.") diff --git a/src/ipam/models/range.py b/src/ipam/models/range.py index 50f0b36..ba9504a 100644 --- a/src/ipam/models/range.py +++ b/src/ipam/models/range.py @@ -70,7 +70,9 @@ class Range(BaseModel): ) inheritance_parent: Optional[StrictStr] = Field( default=None, description="The resource identifier.") - inheritance_sources: Optional[DHCPOptionsInheritance] = None + inheritance_sources: Optional[DHCPOptionsInheritance] = Field( + default=None, + description="The DHCP inheritance configuration for the range.") name: Optional[StrictStr] = Field( default=None, description= @@ -85,14 +87,21 @@ class Range(BaseModel): start: StrictStr = Field(description="The start IP address of the range.") tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for the range in JSON format.") - threshold: Optional[UtilizationThreshold] = None + threshold: Optional[UtilizationThreshold] = Field( + default=None, + description="The utilization threshold settings for the range.") updated_at: Optional[datetime] = Field( default=None, description= "Time when the object has been updated. Equals to _created_at_ if not updated after creation." ) - utilization: Optional[Utilization] = None - utilization_v6: Optional[UtilizationV6] = None + utilization: Optional[Utilization] = Field( + default=None, + description= + "The utilization statistics of IPV4 addresses for the range.") + utilization_v6: Optional[UtilizationV6] = Field( + default=None, + description="The utilization of IPV6 addresses in the range.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "comment", "created_at", "dhcp_host", "dhcp_options", "disable_dhcp", @@ -136,6 +145,8 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ @@ -144,6 +155,8 @@ def to_dict(self) -> Dict[str, Any]: "inheritance_assigned_hosts", "protocol", "updated_at", + "utilization", + "utilization_v6", "additional_properties", ]) diff --git a/src/ipam/models/read_address_block_response.py b/src/ipam/models/read_address_block_response.py index 74ee9f4..7c8fe40 100644 --- a/src/ipam/models/read_address_block_response.py +++ b/src/ipam/models/read_address_block_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address_block import AddressBlock from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadAddressBlockResponse(BaseModel): """ The response format to retrieve the __AddressBlock__ object. """ # noqa: E501 - result: Optional[AddressBlock] = None + result: Optional[AddressBlock] = Field( + default=None, description="The AddressBlock object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_address_response.py b/src/ipam/models/read_address_response.py index 1b03ace..7de59e5 100644 --- a/src/ipam/models/read_address_response.py +++ b/src/ipam/models/read_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address import Address from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadAddressResponse(BaseModel): """ The response format to retrieve the __Address__ object. """ # noqa: E501 - result: Optional[Address] = None + result: Optional[Address] = Field(default=None, + description="The Address object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_asm_response.py b/src/ipam/models/read_asm_response.py index 770f21b..0783234 100644 --- a/src/ipam/models/read_asm_response.py +++ b/src/ipam/models/read_asm_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.asm import ASM from typing import Optional, Set @@ -27,7 +27,7 @@ class ReadASMResponse(BaseModel): """ The response format to retrieve the __ASM__ object. """ # noqa: E501 - result: Optional[ASM] = None + result: Optional[ASM] = Field(default=None, description="The ASM object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_dns_usage_response.py b/src/ipam/models/read_dns_usage_response.py index 54e8d77..141ec5d 100644 --- a/src/ipam/models/read_dns_usage_response.py +++ b/src/ipam/models/read_dns_usage_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.dns_usage import DNSUsage from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadDNSUsageResponse(BaseModel): """ The response format to retrieve the __DNSUsage__ object. """ # noqa: E501 - result: Optional[DNSUsage] = None + result: Optional[DNSUsage] = Field(default=None, + description="The DNSUsage object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_fixed_address_response.py b/src/ipam/models/read_fixed_address_response.py index ce6efa2..156e606 100644 --- a/src/ipam/models/read_fixed_address_response.py +++ b/src/ipam/models/read_fixed_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.fixed_address import FixedAddress from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadFixedAddressResponse(BaseModel): """ The response format to retrieve the __FixedAddress__ object. """ # noqa: E501 - result: Optional[FixedAddress] = None + result: Optional[FixedAddress] = Field( + default=None, description="The FixedAddress object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_global_response.py b/src/ipam/models/read_global_response.py index 6c7d818..4b73aaa 100644 --- a/src/ipam/models/read_global_response.py +++ b/src/ipam/models/read_global_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.dhcp_global import DHCPGlobal from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadGlobalResponse(BaseModel): """ The response format to retrieve the __Global__ object. """ # noqa: E501 - result: Optional[DHCPGlobal] = None + result: Optional[DHCPGlobal] = Field(default=None, + description="The Global object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_ha_group_response.py b/src/ipam/models/read_ha_group_response.py index c054135..2750173 100644 --- a/src/ipam/models/read_ha_group_response.py +++ b/src/ipam/models/read_ha_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ha_group import HAGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadHAGroupResponse(BaseModel): """ The response format to retrieve the __HAGroup__ object. """ # noqa: E501 - result: Optional[HAGroup] = None + result: Optional[HAGroup] = Field(default=None, + description="The HAGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_hardware_filter_response.py b/src/ipam/models/read_hardware_filter_response.py index 45723b5..e50487f 100644 --- a/src/ipam/models/read_hardware_filter_response.py +++ b/src/ipam/models/read_hardware_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.hardware_filter import HardwareFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadHardwareFilterResponse(BaseModel): """ The response format to retrieve the __HardwareFilter__ object. """ # noqa: E501 - result: Optional[HardwareFilter] = None + result: Optional[HardwareFilter] = Field( + default=None, description="The HardwareFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_host_response.py b/src/ipam/models/read_host_response.py index 82c368a..717a7f3 100644 --- a/src/ipam/models/read_host_response.py +++ b/src/ipam/models/read_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.host import Host from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadHostResponse(BaseModel): """ The response format to retrieve the DHCP __Host__ object. """ # noqa: E501 - result: Optional[Host] = None + result: Optional[Host] = Field(default=None, + description="The DHCP Host object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_ip_space_response.py b/src/ipam/models/read_ip_space_response.py index b16d87a..5c70a11 100644 --- a/src/ipam/models/read_ip_space_response.py +++ b/src/ipam/models/read_ip_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ip_space import IPSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadIPSpaceResponse(BaseModel): """ The response format to retrieve the __IPSpace__ object. """ # noqa: E501 - result: Optional[IPSpace] = None + result: Optional[IPSpace] = Field(default=None, + description="The IPSpace object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_ipam_host_response.py b/src/ipam/models/read_ipam_host_response.py index 5288553..7344b90 100644 --- a/src/ipam/models/read_ipam_host_response.py +++ b/src/ipam/models/read_ipam_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ipam_host import IpamHost from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadIpamHostResponse(BaseModel): """ The response format to retrieve the __IpamHost__ object. """ # noqa: E501 - result: Optional[IpamHost] = None + result: Optional[IpamHost] = Field(default=None, + description="The IpamHost object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_option_code_response.py b/src/ipam/models/read_option_code_response.py index 2c54be6..d3a96ef 100644 --- a/src/ipam/models/read_option_code_response.py +++ b/src/ipam/models/read_option_code_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_code import OptionCode from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadOptionCodeResponse(BaseModel): """ The response format to retrieve the __OptionCode__ object. """ # noqa: E501 - result: Optional[OptionCode] = None + result: Optional[OptionCode] = Field(default=None, + description="The OptionCode object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_option_filter_response.py b/src/ipam/models/read_option_filter_response.py index 2df6263..d2ff092 100644 --- a/src/ipam/models/read_option_filter_response.py +++ b/src/ipam/models/read_option_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_filter import OptionFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadOptionFilterResponse(BaseModel): """ The response format to retrieve the __OptionFilter__ object. """ # noqa: E501 - result: Optional[OptionFilter] = None + result: Optional[OptionFilter] = Field( + default=None, description="The OptionFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_option_group_response.py b/src/ipam/models/read_option_group_response.py index 87ab7f1..b3f290b 100644 --- a/src/ipam/models/read_option_group_response.py +++ b/src/ipam/models/read_option_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_group import OptionGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadOptionGroupResponse(BaseModel): """ The response format to retrieve the __OptionGroup__ object. """ # noqa: E501 - result: Optional[OptionGroup] = None + result: Optional[OptionGroup] = Field( + default=None, description="The OptionGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_option_space_response.py b/src/ipam/models/read_option_space_response.py index 72ecf44..a9eb459 100644 --- a/src/ipam/models/read_option_space_response.py +++ b/src/ipam/models/read_option_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_space import OptionSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadOptionSpaceResponse(BaseModel): """ The response format to retrieve the __OptionSpace__ object. """ # noqa: E501 - result: Optional[OptionSpace] = None + result: Optional[OptionSpace] = Field( + default=None, description="The OptionSpace object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_range_response.py b/src/ipam/models/read_range_response.py index a4a5a57..6726947 100644 --- a/src/ipam/models/read_range_response.py +++ b/src/ipam/models/read_range_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.range import Range from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadRangeResponse(BaseModel): """ The response format to retrieve the __Range__ object. """ # noqa: E501 - result: Optional[Range] = None + result: Optional[Range] = Field(default=None, + description="The Range object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_server_response.py b/src/ipam/models/read_server_response.py index 3fc71b8..1933756 100644 --- a/src/ipam/models/read_server_response.py +++ b/src/ipam/models/read_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.server import Server from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadServerResponse(BaseModel): """ The response format to retrieve the __Server__ object. """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/read_subnet_response.py b/src/ipam/models/read_subnet_response.py index 99c8186..3aee344 100644 --- a/src/ipam/models/read_subnet_response.py +++ b/src/ipam/models/read_subnet_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.subnet import Subnet from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadSubnetResponse(BaseModel): """ The response format to retrieve the __Subnet__ object. """ # noqa: E501 - result: Optional[Subnet] = None + result: Optional[Subnet] = Field(default=None, + description="The Subnet object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/server.py b/src/ipam/models/server.py index 262d3c7..ac3356e 100644 --- a/src/ipam/models/server.py +++ b/src/ipam/models/server.py @@ -99,7 +99,11 @@ class Server(BaseModel): description= "The DNS zones that DDNS updates can be sent to. There is no resolver fallback. The target zone must be explicitly configured for the update to be performed. Updates are sent to the closest enclosing zone. Error if _ddns_enabled_ is _true_ and the _ddns_domain_ does not have a corresponding entry in _ddns_zones_. Error if there are items with duplicate zone in the list. Defaults to empty list." ) - dhcp_config: Optional[DHCPConfig] = None + dhcp_config: Optional[DHCPConfig] = Field( + default=None, + description= + "The DHCP configuration for the profile. This controls how leases are issued." + ) dhcp_options: Optional[List[OptionItem]] = Field( default=None, description= @@ -142,7 +146,8 @@ class Server(BaseModel): ) id: Optional[StrictStr] = Field(default=None, description="The resource identifier.") - inheritance_sources: Optional[ServerInheritance] = None + inheritance_sources: Optional[ServerInheritance] = Field( + default=None, description="The inheritance configuration.") kerberos_kdc: Optional[StrictStr] = Field( default=None, description= diff --git a/src/ipam/models/server_inheritance.py b/src/ipam/models/server_inheritance.py index f198761..d9a82cb 100644 --- a/src/ipam/models/server_inheritance.py +++ b/src/ipam/models/server_inheritance.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.inheritance_inherited_bool import InheritanceInheritedBool from ipam.models.inheritance_inherited_float import InheritanceInheritedFloat @@ -35,22 +35,80 @@ class ServerInheritance(BaseModel): """ The inheritance configuration specifies how and which fields _Server_ object (DHCP Config Profile) inherits from _Global_ parent. """ # noqa: E501 - ddns_block: Optional[InheritedDDNSBlock] = None - ddns_client_update: Optional[InheritanceInheritedString] = None - ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = None - ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = None - ddns_ttl_percent: Optional[InheritanceInheritedFloat] = None - ddns_update_on_renew: Optional[InheritanceInheritedBool] = None - ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = None - dhcp_config: Optional[InheritedDHCPConfig] = None - dhcp_options: Optional[InheritedDHCPOptionList] = None - dhcp_options_v6: Optional[InheritedDHCPOptionList] = None - header_option_filename: Optional[InheritanceInheritedString] = None - header_option_server_address: Optional[InheritanceInheritedString] = None - header_option_server_name: Optional[InheritanceInheritedString] = None - hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = None + ddns_block: Optional[InheritedDDNSBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_enabled_, _ddns_send_updates_, _ddns_domain_, _ddns_zones_ fields from _Server_ object." + ) + ddns_client_update: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_client_update_ field from _Server_ object." + ) + ddns_conflict_resolution_mode: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _ddns_conflict_resolution_mode_ field from _Server_ object." + ) + ddns_hostname_block: Optional[InheritedDDNSHostnameBlock] = Field( + default=None, + description= + "The inheritance configuration for _ddns_generate_name_ and _ddns_generated_prefix_ fields from _Server_ object." + ) + ddns_ttl_percent: Optional[InheritanceInheritedFloat] = Field( + default=None, + description= + "The inheritance configuration for _ddns_ttl_percent_ field from _Server_ object." + ) + ddns_update_on_renew: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_update_on_renew_ field from _Server_ object." + ) + ddns_use_conflict_resolution: Optional[InheritanceInheritedBool] = Field( + default=None, + description= + "The inheritance configuration for _ddns_use_conflict_resolution_ field from _Server_ object." + ) + dhcp_config: Optional[InheritedDHCPConfig] = Field( + default=None, + description= + "The inheritance configuration for _dhcp_config_ field from _Server_ object." + ) + dhcp_options: Optional[InheritedDHCPOptionList] = Field( + default=None, + description= + "The inheritance configuration for _dhcp_options_ field from _Server_ object." + ) + dhcp_options_v6: Optional[InheritedDHCPOptionList] = Field( + default=None, + description= + "The inheritance configuration for _dhcp_options_v6_ field from _Server_ object." + ) + header_option_filename: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_filename_ field.") + header_option_server_address: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_address_ field." + ) + header_option_server_name: Optional[InheritanceInheritedString] = Field( + default=None, + description= + "The inheritance configuration for _header_option_server_name_ field.") + hostname_rewrite_block: Optional[InheritedHostnameRewriteBlock] = Field( + default=None, + description= + "The inheritance configuration for _hostname_rewrite_enabled_, _hostname_rewrite_regex_, _hostname_rewrite_char_ fields from _Server_ object." + ) vendor_specific_option_option_space: Optional[ - InheritanceInheritedIdentifier] = None + InheritanceInheritedIdentifier] = Field( + default=None, + description= + "The inheritance configuration for _vendor_specific_option_option_space_ field from _Server_ object." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "ddns_block", "ddns_client_update", "ddns_conflict_resolution_mode", diff --git a/src/ipam/models/subnet.py b/src/ipam/models/subnet.py index 2c84b0f..6eef6a4 100644 --- a/src/ipam/models/subnet.py +++ b/src/ipam/models/subnet.py @@ -42,7 +42,10 @@ class Subnet(BaseModel): description= "The address of the subnet in the form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the _cidr_ field. When reading, the _address_ field is always in the form “a.b.c.d”." ) - asm_config: Optional[ASMConfig] = None + asm_config: Optional[ASMConfig] = Field( + default=None, + description= + "The Automated Scope Management configuration for the subnet.") asm_scope_flag: Optional[StrictInt] = Field( default=None, description= @@ -104,7 +107,11 @@ class Subnet(BaseModel): description= "When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients. Defaults to _true_." ) - dhcp_config: Optional[DHCPConfig] = None + dhcp_config: Optional[DHCPConfig] = Field( + default=None, + description= + "The DHCP configuration of the subnet that controls how leases are issued." + ) dhcp_host: Optional[StrictStr] = Field( default=None, description="The resource identifier.") dhcp_options: Optional[List[OptionItem]] = Field( @@ -112,7 +119,11 @@ class Subnet(BaseModel): description= "The DHCP options of the subnet. This can either be a specific option or a group of options." ) - dhcp_utilization: Optional[DHCPUtilization] = None + dhcp_utilization: Optional[DHCPUtilization] = Field( + default=None, + description= + "The utilization of IP addresses within the DHCP ranges of the subnet." + ) disable_dhcp: Optional[StrictBool] = Field( default=None, description= @@ -157,7 +168,9 @@ class Subnet(BaseModel): ) inheritance_parent: Optional[StrictStr] = Field( default=None, description="The resource identifier.") - inheritance_sources: Optional[DHCPInheritance] = None + inheritance_sources: Optional[DHCPInheritance] = Field( + default=None, + description="The DHCP inheritance configuration for the subnet.") name: Optional[StrictStr] = Field( default=None, description= @@ -176,7 +189,10 @@ class Subnet(BaseModel): description="The resource identifier.") tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for the subnet in JSON format.") - threshold: Optional[UtilizationThreshold] = None + threshold: Optional[UtilizationThreshold] = Field( + default=None, + description= + "The IP address utilization threshold settings for the subnet.") updated_at: Optional[datetime] = Field( default=None, description= @@ -187,8 +203,12 @@ class Subnet(BaseModel): description= "The usage is a combination of indicators, each tracking a specific associated use. Listed below are usage indicators with their meaning: usage indicator | description ---------------------- | -------------------------------- _IPAM_ | Subnet is managed in BloxOne DDI. _DHCP_ | Subnet is served by a DHCP Host. _DISCOVERED_ | Subnet is discovered by some network discovery probe like Network Insight or NetMRI in NIOS." ) - utilization: Optional[Utilization] = None - utilization_v6: Optional[UtilizationV6] = None + utilization: Optional[Utilization] = Field( + default=None, + description="The IPV4 address utilization statistics of the subnet.") + utilization_v6: Optional[UtilizationV6] = Field( + default=None, + description="The utilization of IPV6 addresses in the subnet.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "address", "asm_config", "asm_scope_flag", "cidr", "comment", @@ -244,11 +264,15 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ "asm_scope_flag", "created_at", + "dhcp_utilization", "discovery_attrs", "discovery_metadata", "id", @@ -256,6 +280,8 @@ def to_dict(self) -> Dict[str, Any]: "protocol", "updated_at", "usage", + "utilization", + "utilization_v6", "additional_properties", ]) diff --git a/src/ipam/models/update_address_block_response.py b/src/ipam/models/update_address_block_response.py index 129cc84..a9f96fc 100644 --- a/src/ipam/models/update_address_block_response.py +++ b/src/ipam/models/update_address_block_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address_block import AddressBlock from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateAddressBlockResponse(BaseModel): """ The response format to update the __AddressBlock__ object. """ # noqa: E501 - result: Optional[AddressBlock] = None + result: Optional[AddressBlock] = Field( + default=None, description="The AddressBlock object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_address_response.py b/src/ipam/models/update_address_response.py index 162b441..605a4ce 100644 --- a/src/ipam/models/update_address_response.py +++ b/src/ipam/models/update_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.address import Address from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateAddressResponse(BaseModel): """ The response format to update the __Address__ object. """ # noqa: E501 - result: Optional[Address] = None + result: Optional[Address] = Field(default=None, + description="The Address object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_fixed_address_response.py b/src/ipam/models/update_fixed_address_response.py index 5ac8aa9..008dcd1 100644 --- a/src/ipam/models/update_fixed_address_response.py +++ b/src/ipam/models/update_fixed_address_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.fixed_address import FixedAddress from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateFixedAddressResponse(BaseModel): """ The response format to update the __FixedAddress__ object. """ # noqa: E501 - result: Optional[FixedAddress] = None + result: Optional[FixedAddress] = Field( + default=None, description="The FixedAddress object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_global_response.py b/src/ipam/models/update_global_response.py index 2e5c72a..53d344b 100644 --- a/src/ipam/models/update_global_response.py +++ b/src/ipam/models/update_global_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.dhcp_global import DHCPGlobal from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateGlobalResponse(BaseModel): """ The response format to update the __Global__ object. """ # noqa: E501 - result: Optional[DHCPGlobal] = None + result: Optional[DHCPGlobal] = Field(default=None, + description="The Global object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_ha_group_response.py b/src/ipam/models/update_ha_group_response.py index 9c9e1a8..e13e66b 100644 --- a/src/ipam/models/update_ha_group_response.py +++ b/src/ipam/models/update_ha_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ha_group import HAGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateHAGroupResponse(BaseModel): """ The response format to update the __HAGroup__ object. """ # noqa: E501 - result: Optional[HAGroup] = None + result: Optional[HAGroup] = Field(default=None, + description="The HAGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_hardware_filter_response.py b/src/ipam/models/update_hardware_filter_response.py index 2184b35..09e4693 100644 --- a/src/ipam/models/update_hardware_filter_response.py +++ b/src/ipam/models/update_hardware_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.hardware_filter import HardwareFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateHardwareFilterResponse(BaseModel): """ The response format to update the __HardwareFilter__ object. """ # noqa: E501 - result: Optional[HardwareFilter] = None + result: Optional[HardwareFilter] = Field( + default=None, description="The HardwareFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_host_response.py b/src/ipam/models/update_host_response.py index 414186e..33f1e91 100644 --- a/src/ipam/models/update_host_response.py +++ b/src/ipam/models/update_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.host import Host from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateHostResponse(BaseModel): """ The response format to update the DHCP __Host__ object. """ # noqa: E501 - result: Optional[Host] = None + result: Optional[Host] = Field(default=None, + description="The DHCP Host object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_ip_space_response.py b/src/ipam/models/update_ip_space_response.py index 9031cb4..0af3083 100644 --- a/src/ipam/models/update_ip_space_response.py +++ b/src/ipam/models/update_ip_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ip_space import IPSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateIPSpaceResponse(BaseModel): """ The response format to update the __IPSpace__ object. """ # noqa: E501 - result: Optional[IPSpace] = None + result: Optional[IPSpace] = Field(default=None, + description="The IPSpace object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_ipam_host_response.py b/src/ipam/models/update_ipam_host_response.py index 9191b49..8cabf74 100644 --- a/src/ipam/models/update_ipam_host_response.py +++ b/src/ipam/models/update_ipam_host_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.ipam_host import IpamHost from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateIpamHostResponse(BaseModel): """ The response format to update the _IpamHost__ object. """ # noqa: E501 - result: Optional[IpamHost] = None + result: Optional[IpamHost] = Field(default=None, + description="The IpamHost object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_option_code_response.py b/src/ipam/models/update_option_code_response.py index 950cf14..2d03f00 100644 --- a/src/ipam/models/update_option_code_response.py +++ b/src/ipam/models/update_option_code_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_code import OptionCode from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateOptionCodeResponse(BaseModel): """ The response format to update the __OptionCode__ object. """ # noqa: E501 - result: Optional[OptionCode] = None + result: Optional[OptionCode] = Field(default=None, + description="The OptionCode object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_option_filter_response.py b/src/ipam/models/update_option_filter_response.py index 018fbfb..665ce5a 100644 --- a/src/ipam/models/update_option_filter_response.py +++ b/src/ipam/models/update_option_filter_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_filter import OptionFilter from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateOptionFilterResponse(BaseModel): """ The response format to update the __OptionFilter__ object. """ # noqa: E501 - result: Optional[OptionFilter] = None + result: Optional[OptionFilter] = Field( + default=None, description="The OptionFilter object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_option_group_response.py b/src/ipam/models/update_option_group_response.py index c42a8d4..0cf46d7 100644 --- a/src/ipam/models/update_option_group_response.py +++ b/src/ipam/models/update_option_group_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_group import OptionGroup from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateOptionGroupResponse(BaseModel): """ The response format to update the __OptionGroup__ object. """ # noqa: E501 - result: Optional[OptionGroup] = None + result: Optional[OptionGroup] = Field( + default=None, description="The OptionGroup object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_option_space_response.py b/src/ipam/models/update_option_space_response.py index a9e3d7a..51950c6 100644 --- a/src/ipam/models/update_option_space_response.py +++ b/src/ipam/models/update_option_space_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.option_space import OptionSpace from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateOptionSpaceResponse(BaseModel): """ The response format to update the __OptionSpace__ object. """ # noqa: E501 - result: Optional[OptionSpace] = None + result: Optional[OptionSpace] = Field( + default=None, description="The OptionSpace object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_range_response.py b/src/ipam/models/update_range_response.py index 4af7438..2cbbc69 100644 --- a/src/ipam/models/update_range_response.py +++ b/src/ipam/models/update_range_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.range import Range from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateRangeResponse(BaseModel): """ The response format to update the __Range__ object. """ # noqa: E501 - result: Optional[Range] = None + result: Optional[Range] = Field(default=None, + description="The Range object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_server_response.py b/src/ipam/models/update_server_response.py index 6f65ad6..bce4a30 100644 --- a/src/ipam/models/update_server_response.py +++ b/src/ipam/models/update_server_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.server import Server from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateServerResponse(BaseModel): """ The response format to update the __Server__ object. """ # noqa: E501 - result: Optional[Server] = None + result: Optional[Server] = Field(default=None, + description="The Server object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/ipam/models/update_subnet_response.py b/src/ipam/models/update_subnet_response.py index d7d8e75..a7aed0f 100644 --- a/src/ipam/models/update_subnet_response.py +++ b/src/ipam/models/update_subnet_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from ipam.models.subnet import Subnet from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateSubnetResponse(BaseModel): """ The response format to update the __Subnet__ object. """ # noqa: E501 - result: Optional[Subnet] = None + result: Optional[Subnet] = Field(default=None, + description="The Subnet object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/docs/CreateTSIGKeyResponse.md b/src/keys/docs/CreateTSIGKeyResponse.md index adc722d..f8469ba 100644 --- a/src/keys/docs/CreateTSIGKeyResponse.md +++ b/src/keys/docs/CreateTSIGKeyResponse.md @@ -6,7 +6,7 @@ The response format to create a __TSIGKey__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**TSIGKey**](TSIGKey.md) | | [optional] +**result** | [**TSIGKey**](TSIGKey.md) | The created TSIGKey object. | [optional] ## Example diff --git a/src/keys/docs/GenerateTSIGResponse.md b/src/keys/docs/GenerateTSIGResponse.md index 19fc68b..2648830 100644 --- a/src/keys/docs/GenerateTSIGResponse.md +++ b/src/keys/docs/GenerateTSIGResponse.md @@ -6,7 +6,7 @@ The response format to generate the TSIG key. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**GenerateTSIGResult**](GenerateTSIGResult.md) | | [optional] +**result** | [**GenerateTSIGResult**](GenerateTSIGResult.md) | The generated TSIG key. | [optional] ## Example diff --git a/src/keys/docs/ReadKerberosKeyResponse.md b/src/keys/docs/ReadKerberosKeyResponse.md index 38ca24d..8cfb00f 100644 --- a/src/keys/docs/ReadKerberosKeyResponse.md +++ b/src/keys/docs/ReadKerberosKeyResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __KerberosKey__ resource extracted from the Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**KerberosKey**](KerberosKey.md) | | [optional] +**result** | [**KerberosKey**](KerberosKey.md) | The __KerberosKey__ object. | [optional] ## Example diff --git a/src/keys/docs/ReadTSIGKeyResponse.md b/src/keys/docs/ReadTSIGKeyResponse.md index 2861293..78e1c46 100644 --- a/src/keys/docs/ReadTSIGKeyResponse.md +++ b/src/keys/docs/ReadTSIGKeyResponse.md @@ -6,7 +6,7 @@ The response format to retrieve the __TSIGKey__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**TSIGKey**](TSIGKey.md) | | [optional] +**result** | [**TSIGKey**](TSIGKey.md) | The TSIGKey object. | [optional] ## Example diff --git a/src/keys/docs/UpdateKerberosKeyResponse.md b/src/keys/docs/UpdateKerberosKeyResponse.md index 79b4e53..1e8ba44 100644 --- a/src/keys/docs/UpdateKerberosKeyResponse.md +++ b/src/keys/docs/UpdateKerberosKeyResponse.md @@ -6,7 +6,7 @@ The response format to update __KerberosKey__ resource extracted from the upload Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**KerberosKey**](KerberosKey.md) | | [optional] +**result** | [**KerberosKey**](KerberosKey.md) | The __KerberosKey__ object. | [optional] ## Example diff --git a/src/keys/docs/UpdateTSIGKeyResponse.md b/src/keys/docs/UpdateTSIGKeyResponse.md index 821875b..bfca638 100644 --- a/src/keys/docs/UpdateTSIGKeyResponse.md +++ b/src/keys/docs/UpdateTSIGKeyResponse.md @@ -6,7 +6,7 @@ The response format to update __TSIGKey__ object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | [**TSIGKey**](TSIGKey.md) | | [optional] +**result** | [**TSIGKey**](TSIGKey.md) | The TSIGKey object. | [optional] ## Example diff --git a/src/keys/docs/UploadRequest.md b/src/keys/docs/UploadRequest.md index 1f3957d..5bfcd20 100644 --- a/src/keys/docs/UploadRequest.md +++ b/src/keys/docs/UploadRequest.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **content** | **str** | Base64 encoded content. | **fields** | [**ProtobufFieldMask**](ProtobufFieldMask.md) | | [optional] **tags** | **object** | The tags for uploaded content in JSON format. | [optional] -**type** | [**UploadContentType**](UploadContentType.md) | | +**type** | [**UploadContentType**](UploadContentType.md) | Type of uploaded content. | ## Example diff --git a/src/keys/models/create_tsig_key_response.py b/src/keys/models/create_tsig_key_response.py index 644c734..43f61a3 100644 --- a/src/keys/models/create_tsig_key_response.py +++ b/src/keys/models/create_tsig_key_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.tsig_key import TSIGKey from typing import Optional, Set @@ -27,7 +27,8 @@ class CreateTSIGKeyResponse(BaseModel): """ The response format to create a __TSIGKey__ object. """ # noqa: E501 - result: Optional[TSIGKey] = None + result: Optional[TSIGKey] = Field( + default=None, description="The created TSIGKey object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/generate_tsig_response.py b/src/keys/models/generate_tsig_response.py index 6082ae8..5297ca3 100644 --- a/src/keys/models/generate_tsig_response.py +++ b/src/keys/models/generate_tsig_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.generate_tsig_result import GenerateTSIGResult from typing import Optional, Set @@ -29,7 +29,8 @@ class GenerateTSIGResponse(BaseModel): """ # noqa: E501 - result: Optional[GenerateTSIGResult] = None + result: Optional[GenerateTSIGResult] = Field( + default=None, description="The generated TSIG key.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/read_kerberos_key_response.py b/src/keys/models/read_kerberos_key_response.py index 1332199..142f9b1 100644 --- a/src/keys/models/read_kerberos_key_response.py +++ b/src/keys/models/read_kerberos_key_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.kerberos_key import KerberosKey from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadKerberosKeyResponse(BaseModel): """ The response format to retrieve the __KerberosKey__ resource extracted from the uploaded keytab file. """ # noqa: E501 - result: Optional[KerberosKey] = None + result: Optional[KerberosKey] = Field( + default=None, description="The __KerberosKey__ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/read_tsig_key_response.py b/src/keys/models/read_tsig_key_response.py index 50f3d43..54a26c8 100644 --- a/src/keys/models/read_tsig_key_response.py +++ b/src/keys/models/read_tsig_key_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.tsig_key import TSIGKey from typing import Optional, Set @@ -27,7 +27,8 @@ class ReadTSIGKeyResponse(BaseModel): """ The response format to retrieve the __TSIGKey__ object. """ # noqa: E501 - result: Optional[TSIGKey] = None + result: Optional[TSIGKey] = Field(default=None, + description="The TSIGKey object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/update_kerberos_key_response.py b/src/keys/models/update_kerberos_key_response.py index df14375..67ecac6 100644 --- a/src/keys/models/update_kerberos_key_response.py +++ b/src/keys/models/update_kerberos_key_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.kerberos_key import KerberosKey from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateKerberosKeyResponse(BaseModel): """ The response format to update __KerberosKey__ resource extracted from the uploaded keytab file. """ # noqa: E501 - result: Optional[KerberosKey] = None + result: Optional[KerberosKey] = Field( + default=None, description="The __KerberosKey__ object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/update_tsig_key_response.py b/src/keys/models/update_tsig_key_response.py index 5b0a1ea..e080f87 100644 --- a/src/keys/models/update_tsig_key_response.py +++ b/src/keys/models/update_tsig_key_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from keys.models.tsig_key import TSIGKey from typing import Optional, Set @@ -27,7 +27,8 @@ class UpdateTSIGKeyResponse(BaseModel): """ The response format to update __TSIGKey__ object. """ # noqa: E501 - result: Optional[TSIGKey] = None + result: Optional[TSIGKey] = Field(default=None, + description="The TSIGKey object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["result"] diff --git a/src/keys/models/upload_request.py b/src/keys/models/upload_request.py index cbe09a2..cbf911b 100644 --- a/src/keys/models/upload_request.py +++ b/src/keys/models/upload_request.py @@ -40,7 +40,7 @@ class UploadRequest(BaseModel): tags: Optional[Dict[str, Any]] = Field( default=None, description="The tags for uploaded content in JSON format.") - type: UploadContentType + type: UploadContentType = Field(description="Type of uploaded content.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "comment", "content", "fields", "tags", "type" diff --git a/src/redirect/docs/CustomRedirectCreateResponse.md b/src/redirect/docs/CustomRedirectCreateResponse.md index f710c83..3ec0087 100644 --- a/src/redirect/docs/CustomRedirectCreateResponse.md +++ b/src/redirect/docs/CustomRedirectCreateResponse.md @@ -6,7 +6,7 @@ The Custom Redirect create response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CustomRedirect**](CustomRedirect.md) | | [optional] +**results** | [**CustomRedirect**](CustomRedirect.md) | The Custom Redirect object. | [optional] ## Example diff --git a/src/redirect/docs/CustomRedirectReadResponse.md b/src/redirect/docs/CustomRedirectReadResponse.md index 1f85e3a..e5284ae 100644 --- a/src/redirect/docs/CustomRedirectReadResponse.md +++ b/src/redirect/docs/CustomRedirectReadResponse.md @@ -6,7 +6,7 @@ The Custom Redirect read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CustomRedirect**](CustomRedirect.md) | | [optional] +**results** | [**CustomRedirect**](CustomRedirect.md) | The Custom Redirect object. | [optional] ## Example diff --git a/src/redirect/docs/CustomRedirectUpdateResponse.md b/src/redirect/docs/CustomRedirectUpdateResponse.md index 41491d1..e37780f 100644 --- a/src/redirect/docs/CustomRedirectUpdateResponse.md +++ b/src/redirect/docs/CustomRedirectUpdateResponse.md @@ -6,7 +6,7 @@ The Custom Redirect update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**CustomRedirect**](CustomRedirect.md) | | [optional] +**results** | [**CustomRedirect**](CustomRedirect.md) | The Custom Redirect object. | [optional] ## Example diff --git a/src/redirect/docs/RedirectPageReadResponse.md b/src/redirect/docs/RedirectPageReadResponse.md index 2065074..8e6fc4e 100644 --- a/src/redirect/docs/RedirectPageReadResponse.md +++ b/src/redirect/docs/RedirectPageReadResponse.md @@ -6,7 +6,7 @@ The Redirect Page read response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**RedirectPage**](RedirectPage.md) | | [optional] +**results** | [**RedirectPage**](RedirectPage.md) | The Redirect Page object. | [optional] ## Example diff --git a/src/redirect/docs/RedirectPageUpdateResponse.md b/src/redirect/docs/RedirectPageUpdateResponse.md index 0d21318..0c01059 100644 --- a/src/redirect/docs/RedirectPageUpdateResponse.md +++ b/src/redirect/docs/RedirectPageUpdateResponse.md @@ -6,7 +6,7 @@ The Redirect Page update response. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**results** | [**RedirectPage**](RedirectPage.md) | | [optional] +**results** | [**RedirectPage**](RedirectPage.md) | The Redirect Page object. | [optional] ## Example diff --git a/src/redirect/models/custom_redirect_create_response.py b/src/redirect/models/custom_redirect_create_response.py index 73083e6..72bc60a 100644 --- a/src/redirect/models/custom_redirect_create_response.py +++ b/src/redirect/models/custom_redirect_create_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from redirect.models.custom_redirect import CustomRedirect from typing import Optional, Set @@ -29,7 +29,8 @@ class CustomRedirectCreateResponse(BaseModel): """ # noqa: E501 - results: Optional[CustomRedirect] = None + results: Optional[CustomRedirect] = Field( + default=None, description="The Custom Redirect object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/redirect/models/custom_redirect_read_response.py b/src/redirect/models/custom_redirect_read_response.py index 3ac0937..93c6edd 100644 --- a/src/redirect/models/custom_redirect_read_response.py +++ b/src/redirect/models/custom_redirect_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from redirect.models.custom_redirect import CustomRedirect from typing import Optional, Set @@ -29,7 +29,8 @@ class CustomRedirectReadResponse(BaseModel): """ # noqa: E501 - results: Optional[CustomRedirect] = None + results: Optional[CustomRedirect] = Field( + default=None, description="The Custom Redirect object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/redirect/models/custom_redirect_update_response.py b/src/redirect/models/custom_redirect_update_response.py index 40639c5..0811d83 100644 --- a/src/redirect/models/custom_redirect_update_response.py +++ b/src/redirect/models/custom_redirect_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from redirect.models.custom_redirect import CustomRedirect from typing import Optional, Set @@ -29,7 +29,8 @@ class CustomRedirectUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[CustomRedirect] = None + results: Optional[CustomRedirect] = Field( + default=None, description="The Custom Redirect object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/redirect/models/redirect_page_read_response.py b/src/redirect/models/redirect_page_read_response.py index 300b42b..a28cf03 100644 --- a/src/redirect/models/redirect_page_read_response.py +++ b/src/redirect/models/redirect_page_read_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from redirect.models.redirect_page import RedirectPage from typing import Optional, Set @@ -29,7 +29,8 @@ class RedirectPageReadResponse(BaseModel): """ # noqa: E501 - results: Optional[RedirectPage] = None + results: Optional[RedirectPage] = Field( + default=None, description="The Redirect Page object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"] diff --git a/src/redirect/models/redirect_page_update_response.py b/src/redirect/models/redirect_page_update_response.py index d22c830..d1ff500 100644 --- a/src/redirect/models/redirect_page_update_response.py +++ b/src/redirect/models/redirect_page_update_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from redirect.models.redirect_page import RedirectPage from typing import Optional, Set @@ -29,7 +29,8 @@ class RedirectPageUpdateResponse(BaseModel): """ # noqa: E501 - results: Optional[RedirectPage] = None + results: Optional[RedirectPage] = Field( + default=None, description="The Redirect Page object.") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["results"]