Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

fix properties where descriptions were not generated because it is a ref #3

Merged
merged 1 commit into from
May 31, 2024
Merged

fix properties where descriptions were not generated because it is a ref #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
150 changes: 0 additions & 150 deletions src/README.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion src/dfp/docs/DfpCreateOrUpdateResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dfp/docs/DfpReadResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions src/dfp/models/dfp_create_or_update_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"]

Expand Down
5 changes: 3 additions & 2 deletions src/dfp/models/dfp_read_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"]

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/ACLItem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/dns_config/docs/AuthZone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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

Expand Down
14 changes: 7 additions & 7 deletions src/dns_config/docs/AuthZoneInheritance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions src/dns_config/docs/BulkCopyView.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/ConvertDomainNameResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateACLResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateAuthNSGResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateAuthZoneResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateDelegationResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateForwardNSGResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateForwardZoneResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateLBDNResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateServerResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/CreateViewResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/dns_config/docs/DNSGlobal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/ExternalPrimary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/dns_config/docs/ExternalSecondary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading
Loading