From b0791ceb2cb36b3f3768a4c179817ea72772096c Mon Sep 17 00:00:00 2001 From: Ashish Mathew Date: Wed, 1 May 2024 14:51:41 -0700 Subject: [PATCH] update documentation (#37) --- anycast/README.md | 2 +- anycast/docs/OnPremAnycastManagerAPI.md | 118 ++++++--------- dfp/README.md | 2 +- dfp/docs/AccountsAPI.md | 4 +- dfp/docs/InfraServicesAPI.md | 38 ++--- dnsconfig/README.md | 2 +- dnsconfig/docs/AclAPI.md | 54 +++---- dnsconfig/docs/AuthNsgAPI.md | 54 +++---- dnsconfig/docs/AuthZoneAPI.md | 74 ++++------ dnsconfig/docs/CacheFlushAPI.md | 4 +- dnsconfig/docs/ConvertDomainNameAPI.md | 3 +- dnsconfig/docs/ConvertRnameAPI.md | 3 +- dnsconfig/docs/DelegationAPI.md | 54 +++---- dnsconfig/docs/ForwardNsgAPI.md | 54 +++---- dnsconfig/docs/ForwardZoneAPI.md | 58 +++----- dnsconfig/docs/GlobalAPI.md | 28 ++-- dnsconfig/docs/HostAPI.md | 56 +++----- dnsconfig/docs/LbdnAPI.md | 54 +++---- dnsconfig/docs/ServerAPI.md | 70 ++++----- dnsconfig/docs/ViewAPI.md | 74 ++++------ dnsdata/README.md | 2 +- dnsdata/docs/RecordAPI.md | 77 ++++------ fw/README.md | 2 +- fw/docs/AccessCodesAPI.md | 40 +++--- fw/docs/AppApprovalsAPI.md | 15 +- fw/docs/ApplicationFiltersAPI.md | 52 +++---- fw/docs/CategoryFiltersAPI.md | 52 +++---- fw/docs/ContentCategoriesAPI.md | 7 +- fw/docs/InternalDomainListsAPI.md | 66 ++++----- fw/docs/NamedListItemsAPI.md | 15 +- fw/docs/NamedListsAPI.md | 89 +++++------- fw/docs/NetworkListsAPI.md | 46 +++--- fw/docs/PopRegionsAPI.md | 28 ++-- fw/docs/SecurityPoliciesAPI.md | 55 +++---- fw/docs/SecurityPolicyRulesAPI.md | 19 +-- fw/docs/ThreatFeedsAPI.md | 19 +-- inframgmt/README.md | 2 +- inframgmt/docs/DetailAPI.md | 56 +++----- inframgmt/docs/HostsAPI.md | 70 ++++----- inframgmt/docs/ServicesAPI.md | 56 +++----- infraprovision/README.md | 2 +- infraprovision/docs/UICSRAPI.md | 45 +++--- infraprovision/docs/UIJoinTokenAPI.md | 55 +++---- ipam/README.md | 2 +- ipam/docs/AddressAPI.md | 60 +++----- ipam/docs/AddressBlockAPI.md | 183 +++++++++--------------- ipam/docs/AsmAPI.md | 24 ++-- ipam/docs/DhcpHostAPI.md | 50 +++---- ipam/docs/DnsUsageAPI.md | 32 ++--- ipam/docs/FilterAPI.md | 28 ++-- ipam/docs/FixedAddressAPI.md | 70 ++++----- ipam/docs/GlobalAPI.md | 28 ++-- ipam/docs/HaGroupAPI.md | 60 +++----- ipam/docs/HardwareFilterAPI.md | 54 +++---- ipam/docs/IpSpaceAPI.md | 81 +++++------ ipam/docs/IpamHostAPI.md | 57 +++----- ipam/docs/LeasesCommandAPI.md | 4 +- ipam/docs/OptionCodeAPI.md | 48 +++---- ipam/docs/OptionFilterAPI.md | 54 +++---- ipam/docs/OptionGroupAPI.md | 54 +++---- ipam/docs/OptionSpaceAPI.md | 54 +++---- ipam/docs/RangeAPI.md | 96 +++++-------- ipam/docs/ServerAPI.md | 70 ++++----- ipam/docs/SubnetAPI.md | 103 ++++++------- keys/README.md | 2 +- keys/docs/GenerateTsigAPI.md | 7 +- keys/docs/KerberosAPI.md | 50 +++---- keys/docs/TsigAPI.md | 54 +++---- keys/docs/UploadAPI.md | 4 +- 69 files changed, 1164 insertions(+), 1841 deletions(-) diff --git a/anycast/README.md b/anycast/README.md index b67fc1e..926bdf8 100644 --- a/anycast/README.md +++ b/anycast/README.md @@ -14,7 +14,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/anycast/docs/OnPremAnycastManagerAPI.md b/anycast/docs/OnPremAnycastManagerAPI.md index 8104680..447c52d 100644 --- a/anycast/docs/OnPremAnycastManagerAPI.md +++ b/anycast/docs/OnPremAnycastManagerAPI.md @@ -65,12 +65,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateAnycastConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPICreateAnycastConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AnycastConfig**](AnycastConfig.md) | | +**body** | [**AnycastConfig**](AnycastConfig.md) | | ### Return type @@ -135,13 +135,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateAnycastVersionRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPICreateAnycastVersionRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type **map[string]interface{}** @@ -205,13 +204,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteAnycastConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIDeleteAnycastConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type **map[string]interface{}** @@ -275,13 +273,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteAnycastVersionRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIDeleteAnycastVersionRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type **map[string]interface{}** @@ -345,13 +342,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteOnpremHostRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIDeleteOnpremHostRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type **map[string]interface{}** @@ -415,13 +411,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetAnycastConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetAnycastConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**AnycastConfigResponse**](AnycastConfigResponse.md) @@ -462,16 +457,9 @@ import ( ) func main() { - accountId := int64(789) // int64 | (optional) - service := "service_example" // string | (optional) - hostId := int64(789) // int64 | (optional) - ophid := "ophid_example" // string | (optional) - isConfigured := true // bool | (optional) - tfilter := "tfilter_example" // string | (optional) - torderBy := "torderBy_example" // string | (optional) apiClient := anycast.NewAPIClient() - resp, r, err := apiClient.OnPremAnycastManagerAPI.GetAnycastConfigList(context.Background()).AccountId(accountId).Service(service).HostId(hostId).Ophid(ophid).IsConfigured(isConfigured).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.OnPremAnycastManagerAPI.GetAnycastConfigList(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnPremAnycastManagerAPI.GetAnycastConfigList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -487,18 +475,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiGetAnycastConfigListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetAnycastConfigListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accountId** | **int64** | | - **service** | **string** | | - **hostId** | **int64** | | - **ophid** | **string** | | - **isConfigured** | **bool** | | - **tfilter** | **string** | | - **torderBy** | **string** | | +**accountId** | **int64** | | +**service** | **string** | | +**hostId** | **int64** | | +**ophid** | **string** | | +**isConfigured** | **bool** | | +**tfilter** | **string** | | +**torderBy** | **string** | | ### Return type @@ -563,13 +551,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetAnycastVersionRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetAnycastVersionRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**AnycastVersion**](AnycastVersion.md) @@ -612,11 +599,9 @@ import ( func main() { ophid := "ophid_example" // string | version := "version_example" // string | - appName := "appName_example" // string | (optional) - appVersion := "appVersion_example" // string | (optional) apiClient := anycast.NewAPIClient() - resp, r, err := apiClient.OnPremAnycastManagerAPI.GetOnpremConfig(context.Background(), ophid, version).AppName(appName).AppVersion(appVersion).Execute() + resp, r, err := apiClient.OnPremAnycastManagerAPI.GetOnpremConfig(context.Background(), ophid, version).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnPremAnycastManagerAPI.GetOnpremConfig``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -637,15 +622,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetOnpremConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetOnpremConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **appName** | **string** | | - **appVersion** | **string** | | +**appName** | **string** | | +**appVersion** | **string** | | ### Return type @@ -689,11 +672,9 @@ import ( func main() { ophid := "ophid_example" // string | version := "version_example" // string | - appName := "appName_example" // string | (optional) - appVersion := "appVersion_example" // string | (optional) apiClient := anycast.NewAPIClient() - resp, r, err := apiClient.OnPremAnycastManagerAPI.GetOnpremConfig2(context.Background(), ophid, version).AppName(appName).AppVersion(appVersion).Execute() + resp, r, err := apiClient.OnPremAnycastManagerAPI.GetOnpremConfig2(context.Background(), ophid, version).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnPremAnycastManagerAPI.GetOnpremConfig2``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -714,15 +695,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetOnpremConfig2Request struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetOnpremConfig2Request` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **appName** | **string** | | - **appVersion** | **string** | | +**appName** | **string** | | +**appVersion** | **string** | | ### Return type @@ -787,13 +766,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetOnpremHostRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetOnpremHostRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**OnpremHostResponse**](OnpremHostResponse.md) @@ -857,13 +835,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetStatusRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetStatusRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ServiceStatusUpdateRequest**](ServiceStatusUpdateRequest.md) @@ -927,13 +904,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiGetStatus2Request struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIGetStatus2Request` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ServiceStatusUpdateRequest**](ServiceStatusUpdateRequest.md) @@ -974,16 +950,9 @@ import ( ) func main() { - accountId := int64(789) // int64 | (optional) - service := "service_example" // string | (optional) - hostId := int64(789) // int64 | (optional) - ophid := "ophid_example" // string | (optional) - isConfigured := true // bool | (optional) - tfilter := "tfilter_example" // string | (optional) - torderBy := "torderBy_example" // string | (optional) apiClient := anycast.NewAPIClient() - resp, r, err := apiClient.OnPremAnycastManagerAPI.ListAnycastConfigsWithRuntimeStatus(context.Background()).AccountId(accountId).Service(service).HostId(hostId).Ophid(ophid).IsConfigured(isConfigured).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.OnPremAnycastManagerAPI.ListAnycastConfigsWithRuntimeStatus(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnPremAnycastManagerAPI.ListAnycastConfigsWithRuntimeStatus``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -999,18 +968,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListAnycastConfigsWithRuntimeStatusRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIListAnycastConfigsWithRuntimeStatusRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accountId** | **int64** | | - **service** | **string** | | - **hostId** | **int64** | | - **ophid** | **string** | | - **isConfigured** | **bool** | | - **tfilter** | **string** | | - **torderBy** | **string** | | +**accountId** | **int64** | | +**service** | **string** | | +**hostId** | **int64** | | +**ophid** | **string** | | +**isConfigured** | **bool** | | +**tfilter** | **string** | | +**torderBy** | **string** | | ### Return type @@ -1075,13 +1044,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadAnycastConfigWithRuntimeStatusRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIReadAnycastConfigWithRuntimeStatusRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**AnycastConfigResponse**](AnycastConfigResponse.md) @@ -1146,13 +1114,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateAnycastConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIUpdateAnycastConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**AnycastConfig**](AnycastConfig.md) | | +**body** | [**AnycastConfig**](AnycastConfig.md) | | ### Return type @@ -1218,13 +1185,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateOnpremHostRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OnPremAnycastManagerAPIUpdateOnpremHostRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**OnpremHost**](OnpremHost.md) | | +**body** | [**OnpremHost**](OnpremHost.md) | | ### Return type diff --git a/dfp/README.md b/dfp/README.md index 5d26453..6ff03c9 100644 --- a/dfp/README.md +++ b/dfp/README.md @@ -13,7 +13,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/dfp/docs/AccountsAPI.md b/dfp/docs/AccountsAPI.md index 881b189..11fa424 100644 --- a/dfp/docs/AccountsAPI.md +++ b/dfp/docs/AccountsAPI.md @@ -49,12 +49,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCheckConfigRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccountsAPICheckConfigRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**TypesConfigCheckRequest**](TypesConfigCheckRequest.md) | | +**body** | [**TypesConfigCheckRequest**](TypesConfigCheckRequest.md) | | ### Return type diff --git a/dfp/docs/InfraServicesAPI.md b/dfp/docs/InfraServicesAPI.md index 0e9e4a6..2389bd4 100644 --- a/dfp/docs/InfraServicesAPI.md +++ b/dfp/docs/InfraServicesAPI.md @@ -56,13 +56,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateOrUpdateDfpServiceRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InfraServicesAPICreateOrUpdateDfpServiceRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**DfpCreateOrUpdatePayload**](DfpCreateOrUpdatePayload.md) | The DNS Forwarding Proxy object. | +**body** | [**DfpCreateOrUpdatePayload**](DfpCreateOrUpdatePayload.md) | The DNS Forwarding Proxy object. | ### Return type @@ -104,14 +103,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | -------- | --------------------------- | | service_name | string | !=, ==, ~, !~, >, <, <=, >= | | internal_domain_lists | [int32] | !=, ==, ~, !~, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | default_security_policy | bool | !=, == | In addition groupping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((service_name=='dfp1')or(policy_id~'oph'))and(default_security_policy!='true')\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := dfp.NewAPIClient() - resp, r, err := apiClient.InfraServicesAPI.ListDfpServices(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.InfraServicesAPI.ListDfpServices(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `InfraServicesAPI.ListDfpServices``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -127,16 +121,16 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListDfpServicesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InfraServicesAPIListDfpServicesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | -------- | --------------------------- | | service_name | string | !=, ==, ~, !~, >, <, <=, >= | | internal_domain_lists | [int32] | !=, ==, ~, !~, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | default_security_policy | bool | !=, == | In addition groupping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((service_name=='dfp1')or(policy_id~'oph'))and(default_security_policy!='true')\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | -------- | --------------------------- | | service_name | string | !=, ==, ~, !~, >, <, <=, >= | | internal_domain_lists | [int32] | !=, ==, ~, !~, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | default_security_policy | bool | !=, == | In addition groupping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((service_name=='dfp1')or(policy_id~'oph'))and(default_security_policy!='true')\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type @@ -179,12 +173,9 @@ import ( func main() { serviceId := "serviceId_example" // string | The On-Prem Application Service identifier. For internal Use only - id := int32(56) // int32 | The DNS Forwarding Proxy object identifier. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | The name of the DNS Forwarding Proxy. Used only if the 'id' field is empty. (optional) apiClient := dfp.NewAPIClient() - resp, r, err := apiClient.InfraServicesAPI.ReadDfpService(context.Background(), serviceId).Id(id).Fields(fields).Name(name).Execute() + resp, r, err := apiClient.InfraServicesAPI.ReadDfpService(context.Background(), serviceId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `InfraServicesAPI.ReadDfpService``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -204,15 +195,14 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadDfpServiceRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InfraServicesAPIReadDfpServiceRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **id** | **int32** | The DNS Forwarding Proxy object identifier. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | The name of the DNS Forwarding Proxy. Used only if the 'id' field is empty. | +**id** | **int32** | The DNS Forwarding Proxy object identifier. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | The name of the DNS Forwarding Proxy. Used only if the 'id' field is empty. | ### Return type diff --git a/dnsconfig/README.md b/dnsconfig/README.md index a39494c..6cb8775 100644 --- a/dnsconfig/README.md +++ b/dnsconfig/README.md @@ -10,7 +10,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/dnsconfig/docs/AclAPI.md b/dnsconfig/docs/AclAPI.md index 353498d..00470d2 100644 --- a/dnsconfig/docs/AclAPI.md +++ b/dnsconfig/docs/AclAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AclAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ACL**](ACL.md) | | +**body** | [**ACL**](ACL.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.AclAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AclAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AclAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.AclAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AclAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AclAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AclAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.AclAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AclAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AclAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewACL("Example ACL") // ACL | apiClient := dnsconfig.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AclAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ACL**](ACL.md) | | +**body** | [**ACL**](ACL.md) | | ### Return type diff --git a/dnsconfig/docs/AuthNsgAPI.md b/dnsconfig/docs/AuthNsgAPI.md index 06c3b87..a885387 100644 --- a/dnsconfig/docs/AuthNsgAPI.md +++ b/dnsconfig/docs/AuthNsgAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthNsgAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AuthNSG**](AuthNSG.md) | | +**body** | [**AuthNSG**](AuthNSG.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.AuthNsgAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthNsgAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthNsgAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.AuthNsgAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthNsgAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthNsgAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthNsgAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.AuthNsgAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthNsgAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthNsgAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewAuthNSG("Example Authoritative DNS Server Group") // AuthNSG | apiClient := dnsconfig.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthNsgAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**AuthNSG**](AuthNSG.md) | | +**body** | [**AuthNSG**](AuthNSG.md) | | ### Return type diff --git a/dnsconfig/docs/AuthZoneAPI.md b/dnsconfig/docs/AuthZoneAPI.md index b869177..166ba61 100644 --- a/dnsconfig/docs/AuthZoneAPI.md +++ b/dnsconfig/docs/AuthZoneAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPICopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CopyAuthZone**](CopyAuthZone.md) | | +**body** | [**CopyAuthZone**](CopyAuthZone.md) | | ### Return type @@ -102,10 +102,9 @@ import ( func main() { body := *dnsconfig.NewAuthZone() // AuthZone | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthZoneAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.AuthZoneAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthZoneAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -121,13 +120,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AuthZone**](AuthZone.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**AuthZone**](AuthZone.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -169,7 +168,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.AuthZoneAPI.Delete(context.Background(), id).Execute() @@ -190,13 +189,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -237,18 +235,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthZoneAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Inherit(inherit).Execute() + resp, r, err := apiClient.AuthZoneAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthZoneAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -264,20 +253,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -319,12 +308,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthZoneAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.AuthZoneAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthZoneAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -344,14 +331,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -393,12 +379,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewAuthZone() // AuthZone | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.AuthZoneAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.AuthZoneAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthZoneAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -418,14 +403,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AuthZoneAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**AuthZone**](AuthZone.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**AuthZone**](AuthZone.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/dnsconfig/docs/CacheFlushAPI.md b/dnsconfig/docs/CacheFlushAPI.md index 7049538..8848ca2 100644 --- a/dnsconfig/docs/CacheFlushAPI.md +++ b/dnsconfig/docs/CacheFlushAPI.md @@ -49,12 +49,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CacheFlushAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CacheFlush**](CacheFlush.md) | | +**body** | [**CacheFlush**](CacheFlush.md) | | ### Return type diff --git a/dnsconfig/docs/ConvertDomainNameAPI.md b/dnsconfig/docs/ConvertDomainNameAPI.md index ac19441..c71e5e8 100644 --- a/dnsconfig/docs/ConvertDomainNameAPI.md +++ b/dnsconfig/docs/ConvertDomainNameAPI.md @@ -53,13 +53,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiConvertRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ConvertDomainNameAPIConvertRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ConvertDomainNameResponse**](ConvertDomainNameResponse.md) diff --git a/dnsconfig/docs/ConvertRnameAPI.md b/dnsconfig/docs/ConvertRnameAPI.md index 5e67e5c..db7ef0f 100644 --- a/dnsconfig/docs/ConvertRnameAPI.md +++ b/dnsconfig/docs/ConvertRnameAPI.md @@ -53,13 +53,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiConvertRNameRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ConvertRnameAPIConvertRNameRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ConvertRNameResponse**](ConvertRNameResponse.md) diff --git a/dnsconfig/docs/DelegationAPI.md b/dnsconfig/docs/DelegationAPI.md index 9c69fa3..08458e8 100644 --- a/dnsconfig/docs/DelegationAPI.md +++ b/dnsconfig/docs/DelegationAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DelegationAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Delegation**](Delegation.md) | | +**body** | [**Delegation**](Delegation.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.DelegationAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DelegationAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.DelegationAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.DelegationAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DelegationAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DelegationAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.DelegationAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.DelegationAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DelegationAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DelegationAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewDelegation() // Delegation | apiClient := dnsconfig.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DelegationAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Delegation**](Delegation.md) | | +**body** | [**Delegation**](Delegation.md) | | ### Return type diff --git a/dnsconfig/docs/ForwardNsgAPI.md b/dnsconfig/docs/ForwardNsgAPI.md index 34aa8f5..1121f6e 100644 --- a/dnsconfig/docs/ForwardNsgAPI.md +++ b/dnsconfig/docs/ForwardNsgAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardNsgAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ForwardNSG**](ForwardNSG.md) | | +**body** | [**ForwardNSG**](ForwardNSG.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.ForwardNsgAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardNsgAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ForwardNsgAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.ForwardNsgAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ForwardNsgAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardNsgAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ForwardNsgAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.ForwardNsgAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ForwardNsgAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardNsgAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewForwardNSG("Example Forward NSG") // ForwardNSG | apiClient := dnsconfig.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardNsgAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ForwardNSG**](ForwardNSG.md) | | +**body** | [**ForwardNSG**](ForwardNSG.md) | | ### Return type diff --git a/dnsconfig/docs/ForwardZoneAPI.md b/dnsconfig/docs/ForwardZoneAPI.md index 7f85936..5021c2f 100644 --- a/dnsconfig/docs/ForwardZoneAPI.md +++ b/dnsconfig/docs/ForwardZoneAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPICopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CopyForwardZone**](CopyForwardZone.md) | | +**body** | [**CopyForwardZone**](CopyForwardZone.md) | | ### Return type @@ -120,12 +120,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ForwardZone**](ForwardZone.md) | | +**body** | [**ForwardZone**](ForwardZone.md) | | ### Return type @@ -167,7 +167,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.ForwardZoneAPI.Delete(context.Background(), id).Execute() @@ -188,13 +188,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -235,17 +234,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ForwardZoneAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.ForwardZoneAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ForwardZoneAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -261,19 +252,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -315,11 +306,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ForwardZoneAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.ForwardZoneAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ForwardZoneAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -339,13 +329,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -387,7 +376,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewForwardZone() // ForwardZone | apiClient := dnsconfig.NewAPIClient() @@ -411,13 +400,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ForwardZoneAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ForwardZone**](ForwardZone.md) | | +**body** | [**ForwardZone**](ForwardZone.md) | | ### Return type diff --git a/dnsconfig/docs/GlobalAPI.md b/dnsconfig/docs/GlobalAPI.md index 73a0b1e..48c914f 100644 --- a/dnsconfig/docs/GlobalAPI.md +++ b/dnsconfig/docs/GlobalAPI.md @@ -33,10 +33,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.GlobalAPI.Read(context.Background()).Fields(fields).Execute() + resp, r, err := apiClient.GlobalAPI.Read(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GlobalAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -52,12 +51,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -99,11 +98,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.GlobalAPI.Read2(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.GlobalAPI.Read2(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GlobalAPI.Read2``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -123,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiRead2Request struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIRead2Request` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -190,12 +187,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Global**](Global.md) | | +**body** | [**Global**](Global.md) | | ### Return type @@ -237,7 +234,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewGlobal("dns/global/cd0ad27d-87f3-4f0f-ac71-91272b4c1492") // Global | apiClient := dnsconfig.NewAPIClient() @@ -261,13 +258,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdate2Request struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIUpdate2Request` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Global**](Global.md) | | +**body** | [**Global**](Global.md) | | ### Return type diff --git a/dnsconfig/docs/HostAPI.md b/dnsconfig/docs/HostAPI.md index 3f7edc6..884a8f4 100644 --- a/dnsconfig/docs/HostAPI.md +++ b/dnsconfig/docs/HostAPI.md @@ -32,18 +32,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.HostAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Inherit(inherit).Execute() + resp, r, err := apiClient.HostAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HostAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -59,20 +50,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -114,12 +105,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.HostAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.HostAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HostAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -139,14 +128,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -188,12 +176,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewHost() // Host | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.HostAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.HostAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HostAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -213,14 +200,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Host**](Host.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Host**](Host.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/dnsconfig/docs/LbdnAPI.md b/dnsconfig/docs/LbdnAPI.md index 7c6faa0..022dd9d 100644 --- a/dnsconfig/docs/LbdnAPI.md +++ b/dnsconfig/docs/LbdnAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LbdnAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LBDN**](LBDN.md) | | +**body** | [**LBDN**](LBDN.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.LbdnAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LbdnAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.LbdnAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.LbdnAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LbdnAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LbdnAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.LbdnAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.LbdnAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LbdnAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LbdnAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewLBDN("example.com", "dns/view/23311109-fad4-448f-a7a7-55ad791ae7eb") // LBDN | apiClient := dnsconfig.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LbdnAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**LBDN**](LBDN.md) | | +**body** | [**LBDN**](LBDN.md) | | ### Return type diff --git a/dnsconfig/docs/ServerAPI.md b/dnsconfig/docs/ServerAPI.md index efcf14a..c3d6ad5 100644 --- a/dnsconfig/docs/ServerAPI.md +++ b/dnsconfig/docs/ServerAPI.md @@ -35,10 +35,9 @@ import ( func main() { body := *dnsconfig.NewServer("Example Primary Hosts DNS Profile") // Server | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -54,13 +53,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Server**](Server.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Server**](Server.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -102,7 +101,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.ServerAPI.Delete(context.Background(), id).Execute() @@ -123,13 +122,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -170,18 +168,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ServerAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -197,20 +186,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -252,12 +241,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -277,14 +264,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -326,12 +312,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewServer("Example Primary Hosts DNS Profile") // Server | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -351,14 +336,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Server**](Server.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Server**](Server.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/dnsconfig/docs/ViewAPI.md b/dnsconfig/docs/ViewAPI.md index 5fc75b3..51a42bc 100644 --- a/dnsconfig/docs/ViewAPI.md +++ b/dnsconfig/docs/ViewAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiBulkCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPIBulkCopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**BulkCopyView**](BulkCopyView.md) | | +**body** | [**BulkCopyView**](BulkCopyView.md) | | ### Return type @@ -102,10 +102,9 @@ import ( func main() { body := *dnsconfig.NewView("Example Config View") // View | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ViewAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ViewAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ViewAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -121,13 +120,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**View**](View.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**View**](View.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -169,7 +168,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() r, err := apiClient.ViewAPI.Delete(context.Background(), id).Execute() @@ -190,13 +189,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -237,18 +235,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ViewAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Inherit(inherit).Execute() + resp, r, err := apiClient.ViewAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ViewAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -264,20 +253,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -319,12 +308,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ViewAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.ViewAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ViewAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -344,14 +331,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -393,12 +379,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsconfig.NewView("Example Config View") // View | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := dnsconfig.NewAPIClient() - resp, r, err := apiClient.ViewAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ViewAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ViewAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -418,14 +403,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ViewAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**View**](View.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**View**](View.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/dnsdata/README.md b/dnsdata/README.md index 6b81848..cc7b0f6 100644 --- a/dnsdata/README.md +++ b/dnsdata/README.md @@ -10,7 +10,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/dnsdata/docs/RecordAPI.md b/dnsdata/docs/RecordAPI.md index 4bfc31f..f5e8c12 100644 --- a/dnsdata/docs/RecordAPI.md +++ b/dnsdata/docs/RecordAPI.md @@ -36,10 +36,9 @@ import ( func main() { body := *dnsdata.NewRecord(map[string]interface{}({"address":"10.0.0.0"})) // Record | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. (optional) apiClient := dnsdata.NewAPIClient() - resp, r, err := apiClient.RecordAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.RecordAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RecordAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -55,13 +54,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Record**](Record.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. | +**body** | [**Record**](Record.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. | ### Return type @@ -103,7 +102,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsdata.NewAPIClient() r, err := apiClient.RecordAPI.Delete(context.Background(), id).Execute() @@ -124,13 +123,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -171,18 +169,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. (optional) apiClient := dnsdata.NewAPIClient() - resp, r, err := apiClient.RecordAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Inherit(inherit).Execute() + resp, r, err := apiClient.RecordAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RecordAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -198,20 +187,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. | ### Return type @@ -253,12 +242,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := dnsdata.NewAPIClient() - resp, r, err := apiClient.RecordAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.RecordAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RecordAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -278,14 +265,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. | ### Return type @@ -327,7 +313,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsdata.NewSOASerialIncrementRequest() // SOASerialIncrementRequest | apiClient := dnsdata.NewAPIClient() @@ -351,13 +337,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiSOASerialIncrementRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPISOASerialIncrementRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**SOASerialIncrementRequest**](SOASerialIncrementRequest.md) | | +**body** | [**SOASerialIncrementRequest**](SOASerialIncrementRequest.md) | | ### Return type @@ -399,12 +384,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *dnsdata.NewRecord(map[string]interface{}({"address":"10.0.0.0"})) // Record | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. (optional) apiClient := dnsdata.NewAPIClient() - resp, r, err := apiClient.RecordAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.RecordAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RecordAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -424,14 +408,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RecordAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Record**](Record.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. | +**body** | [**Record**](Record.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. | ### Return type diff --git a/fw/README.md b/fw/README.md index c35424e..3d7054e 100644 --- a/fw/README.md +++ b/fw/README.md @@ -13,7 +13,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/fw/docs/AccessCodesAPI.md b/fw/docs/AccessCodesAPI.md index 5ffcf43..c6adabf 100644 --- a/fw/docs/AccessCodesAPI.md +++ b/fw/docs/AccessCodesAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateAccessCodeRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPICreateAccessCodeRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | +**body** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | ### Return type @@ -118,12 +118,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteAccessCodesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPIDeleteAccessCodesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AccessCodeDeleteRequest**](AccessCodeDeleteRequest.md) | | +**body** | [**AccessCodeDeleteRequest**](AccessCodeDeleteRequest.md) | | ### Return type @@ -186,13 +186,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleAccessCodesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPIDeleteSingleAccessCodesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,13 +232,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | access_key | string | !=, ==, ~, !~, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | security_policy_id | int32 | !=, ==, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='acc_code')or(name~'key'))and(security_policy_id!=32)\" ``` (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.AccessCodesAPI.ListAccessCodes(context.Background()).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.AccessCodesAPI.ListAccessCodes(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AccessCodesAPI.ListAccessCodes``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -255,15 +250,15 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListAccessCodesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPIListAccessCodesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | access_key | string | !=, ==, ~, !~, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | security_policy_id | int32 | !=, ==, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='acc_code')or(name~'key'))and(security_policy_id!=32)\" ``` | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | access_key | string | !=, ==, ~, !~, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | security_policy_id | int32 | !=, ==, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='acc_code')or(name~'key'))and(security_policy_id!=32)\" ``` | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type @@ -306,10 +301,9 @@ import ( func main() { accessKey := "accessKey_example" // string | The Bypass Code identifier. - name := "name_example" // string | The Bypass Code name. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.AccessCodesAPI.ReadAccessCode(context.Background(), accessKey).Name(name).Execute() + resp, r, err := apiClient.AccessCodesAPI.ReadAccessCode(context.Background(), accessKey).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AccessCodesAPI.ReadAccessCode``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -329,13 +323,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadAccessCodeRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPIReadAccessCodeRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **name** | **string** | The Bypass Code name. | +**name** | **string** | The Bypass Code name. | ### Return type @@ -401,13 +394,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateAccessCodeRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AccessCodesAPIUpdateAccessCodeRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | +**body** | [**AccessCode**](AccessCode.md) | The Bypass Code object. | ### Return type diff --git a/fw/docs/AppApprovalsAPI.md b/fw/docs/AppApprovalsAPI.md index 2644915..23c3d53 100644 --- a/fw/docs/AppApprovalsAPI.md +++ b/fw/docs/AppApprovalsAPI.md @@ -30,10 +30,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.AppApprovalsAPI.ListAppApprovals(context.Background()).Filter(filter).Execute() + resp, r, err := apiClient.AppApprovalsAPI.ListAppApprovals(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AppApprovalsAPI.ListAppApprovals``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,12 +48,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListAppApprovalsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AppApprovalsAPIListAppApprovalsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | ### Return type @@ -115,12 +114,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiReplaceAppApprovalsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AppApprovalsAPIReplaceAppApprovalsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AppApprovalsReplaceRequest**](AppApprovalsReplaceRequest.md) | | +**body** | [**AppApprovalsReplaceRequest**](AppApprovalsReplaceRequest.md) | | ### Return type @@ -179,12 +178,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateAppApprovalsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AppApprovalsAPIUpdateAppApprovalsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AppApprovalsUpdateRequest**](AppApprovalsUpdateRequest.md) | | +**body** | [**AppApprovalsUpdateRequest**](AppApprovalsUpdateRequest.md) | | ### Return type diff --git a/fw/docs/ApplicationFiltersAPI.md b/fw/docs/ApplicationFiltersAPI.md index 6e0504f..da8a7e1 100644 --- a/fw/docs/ApplicationFiltersAPI.md +++ b/fw/docs/ApplicationFiltersAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateApplicationFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPICreateApplicationFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | +**body** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | ### Return type @@ -118,12 +118,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteApplicationFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPIDeleteApplicationFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ApplicationFiltersDeleteRequest**](ApplicationFiltersDeleteRequest.md) | | +**body** | [**ApplicationFiltersDeleteRequest**](ApplicationFiltersDeleteRequest.md) | | ### Return type @@ -186,13 +186,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleApplicationFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPIDeleteSingleApplicationFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,16 +232,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - name Example: ``` ?_filter=\"((name=='app_list1')or(name~'app_list2'))\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.ApplicationFiltersAPI.ListApplicationFilters(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.ApplicationFiltersAPI.ListApplicationFilters(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ApplicationFiltersAPI.ListApplicationFilters``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -258,18 +250,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListApplicationFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPIListApplicationFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - name Example: ``` ?_filter=\"((name=='app_list1')or(name~'app_list2'))\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - name Example: ``` ?_filter=\"((name=='app_list1')or(name~'app_list2'))\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -312,11 +304,9 @@ import ( func main() { id := int32(56) // int32 | The Application Filter object identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | The name of the application filter. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.ApplicationFiltersAPI.ReadApplicationFilter(context.Background(), id).Fields(fields).Name(name).Execute() + resp, r, err := apiClient.ApplicationFiltersAPI.ReadApplicationFilter(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ApplicationFiltersAPI.ReadApplicationFilter``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -336,14 +326,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadApplicationFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPIReadApplicationFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | The name of the application filter. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | The name of the application filter. | ### Return type @@ -409,13 +398,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateApplicationFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ApplicationFiltersAPIUpdateApplicationFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | +**body** | [**ApplicationFilter**](ApplicationFilter.md) | The Application Filter object. | ### Return type diff --git a/fw/docs/CategoryFiltersAPI.md b/fw/docs/CategoryFiltersAPI.md index 1a92acc..7159831 100644 --- a/fw/docs/CategoryFiltersAPI.md +++ b/fw/docs/CategoryFiltersAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateCategoryFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPICreateCategoryFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | +**body** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | ### Return type @@ -118,12 +118,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteCategoryFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPIDeleteCategoryFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CategoryFiltersDeleteRequest**](CategoryFiltersDeleteRequest.md) | | +**body** | [**CategoryFiltersDeleteRequest**](CategoryFiltersDeleteRequest.md) | | ### Return type @@ -186,13 +186,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleCategoryFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPIDeleteSingleCategoryFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,16 +232,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='cat-filter')or(name~'key'))and(name!='something')\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.CategoryFiltersAPI.ListCategoryFilters(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.CategoryFiltersAPI.ListCategoryFilters(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CategoryFiltersAPI.ListCategoryFilters``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -258,18 +250,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListCategoryFiltersRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPIListCategoryFiltersRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='cat-filter')or(name~'key'))and(name!='something')\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition, grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='cat-filter')or(name~'key'))and(name!='something')\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -312,11 +304,9 @@ import ( func main() { id := int32(56) // int32 | The Category Filter object identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.CategoryFiltersAPI.ReadCategoryFilter(context.Background(), id).Fields(fields).Name(name).Execute() + resp, r, err := apiClient.CategoryFiltersAPI.ReadCategoryFilter(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CategoryFiltersAPI.ReadCategoryFilter``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -336,14 +326,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadCategoryFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPIReadCategoryFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | | ### Return type @@ -409,13 +398,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateCategoryFilterRequest struct via the builder pattern +Other parameters are passed through a pointer to a `CategoryFiltersAPIUpdateCategoryFilterRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | +**body** | [**CategoryFilter**](CategoryFilter.md) | The Category Filter object. | ### Return type diff --git a/fw/docs/ContentCategoriesAPI.md b/fw/docs/ContentCategoriesAPI.md index f864dc0..49daabd 100644 --- a/fw/docs/ContentCategoriesAPI.md +++ b/fw/docs/ContentCategoriesAPI.md @@ -30,10 +30,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.ContentCategoriesAPI.ListContentCategories(context.Background()).Fields(fields).Execute() + resp, r, err := apiClient.ContentCategoriesAPI.ListContentCategories(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ContentCategoriesAPI.ListContentCategories``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,12 +48,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListContentCategoriesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ContentCategoriesAPIListContentCategoriesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type diff --git a/fw/docs/InternalDomainListsAPI.md b/fw/docs/InternalDomainListsAPI.md index da42166..7d8ece7 100644 --- a/fw/docs/InternalDomainListsAPI.md +++ b/fw/docs/InternalDomainListsAPI.md @@ -55,12 +55,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPICreateInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | +**body** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | ### Return type @@ -119,12 +119,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIDeleteInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**InternalDomainsDeleteRequest**](InternalDomainsDeleteRequest.md) | | +**body** | [**InternalDomainsDeleteRequest**](InternalDomainsDeleteRequest.md) | | ### Return type @@ -187,13 +187,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIDeleteSingleInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -258,13 +257,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiInternalDomainsItemsPartialUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIInternalDomainsItemsPartialUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**InternalDomainsItems**](InternalDomainsItems.md) | The Internal Domains Items Patch object. | +**body** | [**InternalDomainsItems**](InternalDomainsItems.md) | The Internal Domains Items Patch object. | ### Return type @@ -306,16 +304,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | items | string | ~, !~ | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='internal_dom_a')or(name~'internal_dom_b'))\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.InternalDomainListsAPI.ListInternalDomains(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.InternalDomainListsAPI.ListInternalDomains(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `InternalDomainListsAPI.ListInternalDomains``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -331,18 +322,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIListInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | items | string | ~, !~ | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='internal_dom_a')or(name~'internal_dom_b'))\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | items | string | ~, !~ | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='internal_dom_a')or(name~'internal_dom_b'))\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -385,14 +376,9 @@ import ( func main() { id := int32(56) // int32 | The Internal Domains object identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | The name of InternalDomains object. Used if id==0. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.InternalDomainListsAPI.ReadInternalDomains(context.Background(), id).Fields(fields).Name(name).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.InternalDomainListsAPI.ReadInternalDomains(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `InternalDomainListsAPI.ReadInternalDomains``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -412,17 +398,16 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIReadInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | The name of InternalDomains object. Used if id==0. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | The name of InternalDomains object. Used if id==0. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type @@ -488,13 +473,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateInternalDomainsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `InternalDomainListsAPIUpdateInternalDomainsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | +**body** | [**InternalDomains**](InternalDomains.md) | The Internal Domains object. | ### Return type diff --git a/fw/docs/NamedListItemsAPI.md b/fw/docs/NamedListItemsAPI.md index 095c8b3..1435365 100644 --- a/fw/docs/NamedListItemsAPI.md +++ b/fw/docs/NamedListItemsAPI.md @@ -54,13 +54,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteNamedListItemsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListItemsAPIDeleteNamedListItemsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NamedListItemsDeleteRequest**](NamedListItemsDeleteRequest.md) | | +**body** | [**NamedListItemsDeleteRequest**](NamedListItemsDeleteRequest.md) | | ### Return type @@ -126,13 +125,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiInsertOrReplaceNamedListItemsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListItemsAPIInsertOrReplaceNamedListItemsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NamedListItemsInsertOrUpdate**](NamedListItemsInsertOrUpdate.md) | NamedListItemsInsertOrUpdate object | +**body** | [**NamedListItemsInsertOrUpdate**](NamedListItemsInsertOrUpdate.md) | NamedListItemsInsertOrUpdate object | ### Return type @@ -198,13 +196,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiNamedListItemsPartialUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListItemsAPINamedListItemsPartialUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NamedListItemsPartialUpdate**](NamedListItemsPartialUpdate.md) | NamedListItemsPartialUpdate object | +**body** | [**NamedListItemsPartialUpdate**](NamedListItemsPartialUpdate.md) | NamedListItemsPartialUpdate object | ### Return type diff --git a/fw/docs/NamedListsAPI.md b/fw/docs/NamedListsAPI.md index 8e0da27..6595192 100644 --- a/fw/docs/NamedListsAPI.md +++ b/fw/docs/NamedListsAPI.md @@ -57,12 +57,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNamedListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPICreateNamedListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NamedList**](NamedList.md) | The Named List object. | +**body** | [**NamedList**](NamedList.md) | The Named List object. | ### Return type @@ -121,12 +121,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteNamedListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIDeleteNamedListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NamedListsDeleteRequest**](NamedListsDeleteRequest.md) | | +**body** | [**NamedListsDeleteRequest**](NamedListsDeleteRequest.md) | | ### Return type @@ -189,13 +189,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleNamedListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIDeleteSingleNamedListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -236,16 +235,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.NamedListsAPI.ListNamedLists(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.NamedListsAPI.ListNamedLists(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NamedListsAPI.ListNamedLists``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -261,18 +253,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListNamedListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIListNamedListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -314,13 +306,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.NamedListsAPI.ListNamedListsCSV(context.Background()).Filter(filter).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.NamedListsAPI.ListNamedListsCSV(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NamedListsAPI.ListNamedListsCSV``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -336,15 +324,15 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListNamedListsCSVRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIListNamedListsCSVRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | type | string | ==, != | | items | string | ~, !~ | | items_described | string | == | Grouping operators (and, or, not, ()) are not supported between different fields. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -405,12 +393,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiMultiListUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIMultiListUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**MultiListUpdate**](MultiListUpdate.md) | | +**body** | [**MultiListUpdate**](MultiListUpdate.md) | | ### Return type @@ -453,15 +441,9 @@ import ( func main() { id := int32(56) // int32 | The Named List identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - name := "name_example" // string | The name of the named list. Can be used in pair with 'type' (both fields are mandatory) to request the object by their name. This aproach available only if the field 'id' is empty (==0). (optional) - type_ := "type__example" // string | The type of the named list. See 'NamedList' for more details. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.NamedListsAPI.ReadNamedList(context.Background(), id).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Name(name).Type_(type_).Execute() + resp, r, err := apiClient.NamedListsAPI.ReadNamedList(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NamedListsAPI.ReadNamedList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -481,18 +463,17 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadNamedListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIReadNamedListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **name** | **string** | The name of the named list. Can be used in pair with 'type' (both fields are mandatory) to request the object by their name. This aproach available only if the field 'id' is empty (==0). | - **type_** | **string** | The type of the named list. See 'NamedList' for more details. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**name** | **string** | The name of the named list. Can be used in pair with 'type' (both fields are mandatory) to request the object by their name. This aproach available only if the field 'id' is empty (==0). | +**type_** | **string** | The type of the named list. See 'NamedList' for more details. | ### Return type @@ -558,13 +539,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateNamedListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIUpdateNamedListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NamedList**](NamedList.md) | The Named List object. | +**body** | [**NamedList**](NamedList.md) | The Named List object. | ### Return type @@ -630,13 +610,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateNamedListPartialRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NamedListsAPIUpdateNamedListPartialRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ListSeverityLevels**](ListSeverityLevels.md) | The Named List object. | +**body** | [**ListSeverityLevels**](ListSeverityLevels.md) | The Named List object. | ### Return type diff --git a/fw/docs/NetworkListsAPI.md b/fw/docs/NetworkListsAPI.md index c5be319..424ae45 100644 --- a/fw/docs/NetworkListsAPI.md +++ b/fw/docs/NetworkListsAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNetworkListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPICreateNetworkListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NetworkList**](NetworkList.md) | The Network List object. | +**body** | [**NetworkList**](NetworkList.md) | The Network List object. | ### Return type @@ -118,12 +118,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteNetworkListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPIDeleteNetworkListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NetworkListsDeleteRequest**](NetworkListsDeleteRequest.md) | | +**body** | [**NetworkListsDeleteRequest**](NetworkListsDeleteRequest.md) | | ### Return type @@ -186,13 +186,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleNetworkListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPIDeleteSingleNetworkListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,14 +232,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | default_security_policy | bool | !=, == | | items | string | >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - id, policy_id, name, description, default_security_policy - items Example: ``` ?_filter=\"((name=='net_list1')or(name~'list_b'))and(default_security_policy!='true')\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.NetworkListsAPI.ListNetworkLists(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.NetworkListsAPI.ListNetworkLists(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NetworkListsAPI.ListNetworkLists``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -256,16 +250,16 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListNetworkListsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPIListNetworkListsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | default_security_policy | bool | !=, == | | items | string | >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - id, policy_id, name, description, default_security_policy - items Example: ``` ?_filter=\"((name=='net_list1')or(name~'list_b'))and(default_security_policy!='true')\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ----------------------- | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | policy_id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | default_security_policy | bool | !=, == | | items | string | >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Allowed sets of parameters that can be groupped in one query: - id, policy_id, name, description, default_security_policy - items Example: ``` ?_filter=\"((name=='net_list1')or(name~'list_b'))and(default_security_policy!='true')\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type @@ -308,11 +302,9 @@ import ( func main() { id := int32(56) // int32 | The Network List object identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | The name of the network list. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.NetworkListsAPI.ReadNetworkList(context.Background(), id).Fields(fields).Name(name).Execute() + resp, r, err := apiClient.NetworkListsAPI.ReadNetworkList(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NetworkListsAPI.ReadNetworkList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -332,14 +324,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadNetworkListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPIReadNetworkListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | The name of the network list. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | The name of the network list. | ### Return type @@ -405,13 +396,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateNetworkListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `NetworkListsAPIUpdateNetworkListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NetworkList**](NetworkList.md) | The Network List object. | +**body** | [**NetworkList**](NetworkList.md) | The Network List object. | ### Return type diff --git a/fw/docs/PopRegionsAPI.md b/fw/docs/PopRegionsAPI.md index cc6c041..0ff7a8a 100644 --- a/fw/docs/PopRegionsAPI.md +++ b/fw/docs/PopRegionsAPI.md @@ -31,16 +31,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | region | string | ==, != | | location | string | ~, !~ | Grouping operators (and, or, not, ()) are not supported between different fields. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.PopRegionsAPI.ListPoPRegions(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.PopRegionsAPI.ListPoPRegions(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PopRegionsAPI.ListPoPRegions``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -56,18 +49,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListPoPRegionsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `PopRegionsAPIListPoPRegionsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | region | string | ==, != | | location | string | ~, !~ | Grouping operators (and, or, not, ()) are not supported between different fields. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | region | string | ==, != | | location | string | ~, !~ | Grouping operators (and, or, not, ()) are not supported between different fields. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -132,13 +125,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadPoPRegionRequest struct via the builder pattern +Other parameters are passed through a pointer to a `PopRegionsAPIReadPoPRegionRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ReadPoPRegionResponse**](ReadPoPRegionResponse.md) diff --git a/fw/docs/SecurityPoliciesAPI.md b/fw/docs/SecurityPoliciesAPI.md index c07c35b..22d72d7 100644 --- a/fw/docs/SecurityPoliciesAPI.md +++ b/fw/docs/SecurityPoliciesAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateSecurityPolicyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPICreateSecurityPolicyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | +**body** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | ### Return type @@ -118,12 +118,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSecurityPolicyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPIDeleteSecurityPolicyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**SecurityPolicyDeleteRequest**](SecurityPolicyDeleteRequest.md) | | +**body** | [**SecurityPolicyDeleteRequest**](SecurityPolicyDeleteRequest.md) | | ### Return type @@ -186,13 +186,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSingleSecurityPolicyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPIDeleteSingleSecurityPolicyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,17 +232,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='sec_policy_a')or(name~'policy_b'))and(is_default!='true')\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - includeAccessCodes := true // bool | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | Filtering by tags. (optional) - torderBy := "torderBy_example" // string | Sorting by tags. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.SecurityPoliciesAPI.ListSecurityPolicies(context.Background()).Filter(filter).Fields(fields).IncludeAccessCodes(includeAccessCodes).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.SecurityPoliciesAPI.ListSecurityPolicies(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SecurityPoliciesAPI.ListSecurityPolicies``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -259,19 +250,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListSecurityPoliciesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPIListSecurityPoliciesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='sec_policy_a')or(name~'policy_b'))and(is_default!='true')\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **includeAccessCodes** | **bool** | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | Filtering by tags. | - **torderBy** | **string** | Sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | id | int32 | !=, ==, >, <, <=, >= | | name | string | !=, ==, ~, !~, >, <, <=, >= | | description | string | !=, ==, ~, !~, >, <, <=, >= | | is_default | bool | !=, == | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | Example: ``` ?_filter=\"((name=='sec_policy_a')or(name~'policy_b'))and(is_default!='true')\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**includeAccessCodes** | **bool** | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | Filtering by tags. | +**torderBy** | **string** | Sorting by tags. | ### Return type @@ -314,11 +305,9 @@ import ( func main() { id := int32(56) // int32 | The Security Policy object identifier. - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - name := "name_example" // string | (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.SecurityPoliciesAPI.ReadSecurityPolicy(context.Background(), id).Fields(fields).Name(name).Execute() + resp, r, err := apiClient.SecurityPoliciesAPI.ReadSecurityPolicy(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SecurityPoliciesAPI.ReadSecurityPolicy``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -338,14 +327,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadSecurityPolicyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPIReadSecurityPolicyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **name** | **string** | | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**name** | **string** | | ### Return type @@ -411,13 +399,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateSecurityPolicyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPoliciesAPIUpdateSecurityPolicyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | +**body** | [**SecurityPolicy**](SecurityPolicy.md) | The Security Policy object. | ### Return type diff --git a/fw/docs/SecurityPolicyRulesAPI.md b/fw/docs/SecurityPolicyRulesAPI.md index a63c3a3..9516eb8 100644 --- a/fw/docs/SecurityPolicyRulesAPI.md +++ b/fw/docs/SecurityPolicyRulesAPI.md @@ -30,14 +30,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | policy_id | int32 | == | | list_id | int32 | == | | category_filter_id | int32 | == | Groupping operators (and, or, not, ()) are not supported. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.SecurityPolicyRulesAPI.ListSecurityPolicyRules(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.SecurityPolicyRulesAPI.ListSecurityPolicyRules(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SecurityPolicyRulesAPI.ListSecurityPolicyRules``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -53,16 +48,16 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListSecurityPolicyRulesRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SecurityPolicyRulesAPIListSecurityPolicyRulesRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | policy_id | int32 | == | | list_id | int32 | == | | category_filter_id | int32 | == | Groupping operators (and, or, not, ()) are not supported. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Ops | | ------------------ | ------ | ---------------- | | policy_id | int32 | == | | list_id | int32 | == | | category_filter_id | int32 | == | Groupping operators (and, or, not, ()) are not supported. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type diff --git a/fw/docs/ThreatFeedsAPI.md b/fw/docs/ThreatFeedsAPI.md index bf6344a..03172ce 100644 --- a/fw/docs/ThreatFeedsAPI.md +++ b/fw/docs/ThreatFeedsAPI.md @@ -30,14 +30,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='AntiMalware')or(name~'FarSightNOD'))\" ``` (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) apiClient := fw.NewAPIClient() - resp, r, err := apiClient.ThreatFeedsAPI.ListThreatFeeds(context.Background()).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute() + resp, r, err := apiClient.ThreatFeedsAPI.ListThreatFeeds(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ThreatFeedsAPI.ListThreatFeeds``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -53,16 +48,16 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListThreatFeedsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ThreatFeedsAPIListThreatFeedsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='AntiMalware')or(name~'FarSightNOD'))\" ``` | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: | Name | type | Supported Op | | ------------------ | ------ | --------------------------- | | name | string | !=, ==, ~, !~, >, <, <=, >= | In addition grouping operators are supported: | Op | Description | | --- | -------------------- | | and | Logical AND | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | Example: ``` ?_filter=\"((name=='AntiMalware')or(name~'FarSightNOD'))\" ``` | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | ### Return type diff --git a/inframgmt/README.md b/inframgmt/README.md index 63b4b61..84fa5ba 100644 --- a/inframgmt/README.md +++ b/inframgmt/README.md @@ -57,7 +57,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/inframgmt/docs/DetailAPI.md b/inframgmt/docs/DetailAPI.md index bd6767c..cd5b3d6 100644 --- a/inframgmt/docs/DetailAPI.md +++ b/inframgmt/docs/DetailAPI.md @@ -29,17 +29,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := inframgmt.NewAPIClient() - resp, r, err := apiClient.DetailAPI.HostsList(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Fields(fields).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.DetailAPI.HostsList(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DetailAPI.HostsList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -55,19 +47,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiHostsListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DetailAPIHostsListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -107,17 +99,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := inframgmt.NewAPIClient() - resp, r, err := apiClient.DetailAPI.ServicesList(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Fields(fields).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.DetailAPI.ServicesList(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DetailAPI.ServicesList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -133,19 +117,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiServicesListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DetailAPIServicesListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type diff --git a/inframgmt/docs/HostsAPI.md b/inframgmt/docs/HostsAPI.md index 849cbf8..425f295 100644 --- a/inframgmt/docs/HostsAPI.md +++ b/inframgmt/docs/HostsAPI.md @@ -57,12 +57,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiAssignTagsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIAssignTagsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AssignTagsRequest**](AssignTagsRequest.md) | | +**body** | [**AssignTagsRequest**](AssignTagsRequest.md) | | ### Return type @@ -123,12 +123,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Host**](Host.md) | | +**body** | [**Host**](Host.md) | | ### Return type @@ -170,7 +170,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := inframgmt.NewAPIClient() r, err := apiClient.HostsAPI.Delete(context.Background(), id).Execute() @@ -191,13 +191,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -238,7 +237,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *inframgmt.NewDisconnectRequest() // DisconnectRequest | apiClient := inframgmt.NewAPIClient() @@ -262,13 +261,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDisconnectRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIDisconnectRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**DisconnectRequest**](DisconnectRequest.md) | | +**body** | [**DisconnectRequest**](DisconnectRequest.md) | | ### Return type @@ -308,17 +306,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := inframgmt.NewAPIClient() - resp, r, err := apiClient.HostsAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Fields(fields).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.HostsAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HostsAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -334,19 +324,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -388,7 +378,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := inframgmt.NewAPIClient() resp, r, err := apiClient.HostsAPI.Read(context.Background(), id).Execute() @@ -411,13 +401,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**GetHostResponse**](GetHostResponse.md) @@ -482,14 +471,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReplaceRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIReplaceRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **body** | [**ReplaceHostRequest**](ReplaceHostRequest.md) | | +**body** | [**ReplaceHostRequest**](ReplaceHostRequest.md) | | ### Return type @@ -550,12 +537,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiUnassignTagsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIUnassignTagsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UnassignTagsRequest**](UnassignTagsRequest.md) | | +**body** | [**UnassignTagsRequest**](UnassignTagsRequest.md) | | ### Return type @@ -597,7 +584,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *inframgmt.NewHost("Example Host Name") // Host | apiClient := inframgmt.NewAPIClient() @@ -621,13 +608,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HostsAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Host**](Host.md) | | +**body** | [**Host**](Host.md) | | ### Return type diff --git a/inframgmt/docs/ServicesAPI.md b/inframgmt/docs/ServicesAPI.md index 16fb79c..7495d85 100644 --- a/inframgmt/docs/ServicesAPI.md +++ b/inframgmt/docs/ServicesAPI.md @@ -35,10 +35,9 @@ import ( ) func main() { - accountId := "accountId_example" // string | Account ID. (optional) apiClient := inframgmt.NewAPIClient() - resp, r, err := apiClient.ServicesAPI.Applications(context.Background()).AccountId(accountId).Execute() + resp, r, err := apiClient.ServicesAPI.Applications(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServicesAPI.Applications``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -54,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiApplicationsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPIApplicationsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accountId** | **string** | Account ID. | +**accountId** | **string** | Account ID. | ### Return type @@ -120,12 +119,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Service**](Service.md) | | +**body** | [**Service**](Service.md) | | ### Return type @@ -167,7 +166,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := inframgmt.NewAPIClient() r, err := apiClient.ServicesAPI.Delete(context.Background(), id).Execute() @@ -188,13 +187,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -233,17 +231,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := inframgmt.NewAPIClient() - resp, r, err := apiClient.ServicesAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Fields(fields).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.ServicesAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServicesAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -259,19 +249,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -313,7 +303,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := inframgmt.NewAPIClient() resp, r, err := apiClient.ServicesAPI.Read(context.Background(), id).Execute() @@ -336,13 +326,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**GetServiceResponse**](GetServiceResponse.md) @@ -383,7 +372,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *inframgmt.NewService("Example Service Name", "dhcp/pool/9432a119-6f1e-49c2-bf47-57944773cae6", "dns") // Service | apiClient := inframgmt.NewAPIClient() @@ -407,13 +396,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServicesAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Service**](Service.md) | | +**body** | [**Service**](Service.md) | | ### Return type diff --git a/infraprovision/README.md b/infraprovision/README.md index 367d3e9..3831fa2 100644 --- a/infraprovision/README.md +++ b/infraprovision/README.md @@ -8,7 +8,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/infraprovision/docs/UICSRAPI.md b/infraprovision/docs/UICSRAPI.md index 81c4a09..6abbd1a 100644 --- a/infraprovision/docs/UICSRAPI.md +++ b/infraprovision/docs/UICSRAPI.md @@ -56,13 +56,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiApproveRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UICSRAPIApproveRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**ApproveCSRRequest**](ApproveCSRRequest.md) | | +**body** | [**ApproveCSRRequest**](ApproveCSRRequest.md) | | ### Return type @@ -126,13 +125,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDenyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UICSRAPIDenyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**DenyCSRRequest**](DenyCSRRequest.md) | | +**body** | [**DenyCSRRequest**](DenyCSRRequest.md) | | ### Return type @@ -172,16 +170,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := infraprovision.NewAPIClient() - resp, r, err := apiClient.UICSRAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.UICSRAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UICSRAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -197,18 +188,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UICSRAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -274,13 +265,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiRevokeRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UICSRAPIRevokeRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**RevokeCertRequest**](RevokeCertRequest.md) | | +**body** | [**RevokeCertRequest**](RevokeCertRequest.md) | | ### Return type @@ -346,13 +336,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiRevoke2Request struct via the builder pattern +Other parameters are passed through a pointer to a `UICSRAPIRevoke2Request` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**RevokeCertRequest**](RevokeCertRequest.md) | | +**body** | [**RevokeCertRequest**](RevokeCertRequest.md) | | ### Return type diff --git a/infraprovision/docs/UIJoinTokenAPI.md b/infraprovision/docs/UIJoinTokenAPI.md index 00d6395..9abee51 100644 --- a/infraprovision/docs/UIJoinTokenAPI.md +++ b/infraprovision/docs/UIJoinTokenAPI.md @@ -54,12 +54,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**JoinToken**](JoinToken.md) | | +**body** | [**JoinToken**](JoinToken.md) | | ### Return type @@ -99,7 +99,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := infraprovision.NewAPIClient() r, err := apiClient.UIJoinTokenAPI.Delete(context.Background(), id).Execute() @@ -120,13 +120,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -182,12 +181,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteSetRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPIDeleteSetRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**DeleteJoinTokensRequest**](DeleteJoinTokensRequest.md) | | +**body** | [**DeleteJoinTokensRequest**](DeleteJoinTokensRequest.md) | | ### Return type @@ -229,16 +228,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := infraprovision.NewAPIClient() - resp, r, err := apiClient.UIJoinTokenAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.UIJoinTokenAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UIJoinTokenAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -254,18 +246,18 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -305,11 +297,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := infraprovision.NewAPIClient() - resp, r, err := apiClient.UIJoinTokenAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.UIJoinTokenAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UIJoinTokenAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -329,13 +320,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -377,7 +367,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *infraprovision.NewJoinToken() // JoinToken | apiClient := infraprovision.NewAPIClient() @@ -401,13 +391,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UIJoinTokenAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**JoinToken**](JoinToken.md) | | +**body** | [**JoinToken**](JoinToken.md) | | ### Return type diff --git a/ipam/README.md b/ipam/README.md index 3b2e67a..3d72318 100644 --- a/ipam/README.md +++ b/ipam/README.md @@ -8,7 +8,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/ipam/docs/AddressAPI.md b/ipam/docs/AddressAPI.md index 6cae94f..3158507 100644 --- a/ipam/docs/AddressAPI.md +++ b/ipam/docs/AddressAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Address**](Address.md) | | +**body** | [**Address**](Address.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.AddressAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,19 +167,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - scope := "scope_example" // string | (optional) - addressState := "addressState_example" // string | (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Scope(scope).AddressState(addressState).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.AddressAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -196,21 +185,21 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **scope** | **string** | | - **addressState** | **string** | | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**scope** | **string** | | +**addressState** | **string** | | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -252,11 +241,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.AddressAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -276,13 +264,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -324,7 +311,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewAddress("10.0.0.0") // Address | apiClient := ipam.NewAPIClient() @@ -348,13 +335,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Address**](Address.md) | | +**body** | [**Address**](Address.md) | | ### Return type diff --git a/ipam/docs/AddressBlockAPI.md b/ipam/docs/AddressBlockAPI.md index 9d79843..ca24afd 100644 --- a/ipam/docs/AddressBlockAPI.md +++ b/ipam/docs/AddressBlockAPI.md @@ -41,7 +41,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewCopyAddressBlock("ipam/ip_space/59882b4a-427a-4077-a9b4-f08cb2b97318") // CopyAddressBlock | apiClient := ipam.NewAPIClient() @@ -65,13 +65,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPICopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**CopyAddressBlock**](CopyAddressBlock.md) | | +**body** | [**CopyAddressBlock**](CopyAddressBlock.md) | | ### Return type @@ -114,10 +113,9 @@ import ( func main() { body := *ipam.NewAddressBlock() // AddressBlock | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.AddressBlockAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -133,13 +131,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AddressBlock**](AddressBlock.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**AddressBlock**](AddressBlock.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -181,14 +179,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource cidr := int32(56) // int32 | The cidr value of address blocks to be created. - count := int32(56) // int32 | Number of address blocks to generate. Default 1 if not set. (optional) (default to 1) - name := "name_example" // string | Name of next available address blocks. (optional) - comment := "comment_example" // string | Comment of next available address blocks. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableAB(context.Background(), id).Cidr(cidr).Count(count).Name(name).Comment(comment).Execute() + resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableAB(context.Background(), id).Cidr(cidr).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.CreateNextAvailableAB``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -208,16 +203,15 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNextAvailableABRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPICreateNextAvailableABRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **cidr** | **int32** | The cidr value of address blocks to be created. | - **count** | **int32** | Number of address blocks to generate. Default 1 if not set. | [default to 1] - **name** | **string** | Name of next available address blocks. | - **comment** | **string** | Comment of next available address blocks. | +**cidr** | **int32** | The cidr value of address blocks to be created. | +**count** | **int32** | Number of address blocks to generate. Default 1 if not set. | [default to 1] +**name** | **string** | Name of next available address blocks. | +**comment** | **string** | Comment of next available address blocks. | ### Return type @@ -259,12 +253,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) (default to false) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) (default to 1) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.CreateNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -284,14 +276,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPICreateNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] ### Return type @@ -333,15 +324,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource cidr := int32(56) // int32 | The cidr value of subnets to be created. - count := int32(56) // int32 | Number of subnets to generate. Default 1 if not set. (optional) (default to 1) - name := "name_example" // string | Name of next available subnets. (optional) - comment := "comment_example" // string | Comment of next available subnets. (optional) - dhcpHost := "dhcpHost_example" // string | Reference of OnPrem Host associated with the next available subnets to be created. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableSubnet(context.Background(), id).Cidr(cidr).Count(count).Name(name).Comment(comment).DhcpHost(dhcpHost).Execute() + resp, r, err := apiClient.AddressBlockAPI.CreateNextAvailableSubnet(context.Background(), id).Cidr(cidr).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.CreateNextAvailableSubnet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -361,17 +348,16 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNextAvailableSubnetRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPICreateNextAvailableSubnetRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **cidr** | **int32** | The cidr value of subnets to be created. | - **count** | **int32** | Number of subnets to generate. Default 1 if not set. | [default to 1] - **name** | **string** | Name of next available subnets. | - **comment** | **string** | Comment of next available subnets. | - **dhcpHost** | **string** | Reference of OnPrem Host associated with the next available subnets to be created. | +**cidr** | **int32** | The cidr value of subnets to be created. | +**count** | **int32** | Number of subnets to generate. Default 1 if not set. | [default to 1] +**name** | **string** | Name of next available subnets. | +**comment** | **string** | Comment of next available subnets. | +**dhcpHost** | **string** | Reference of OnPrem Host associated with the next available subnets to be created. | ### Return type @@ -413,7 +399,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.AddressBlockAPI.Delete(context.Background(), id).Execute() @@ -434,13 +420,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -481,18 +466,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.AddressBlockAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -508,20 +484,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -563,14 +539,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - cidr := int32(56) // int32 | The cidr value of address blocks to be created. (optional) - count := int32(56) // int32 | Number of address blocks to generate. Default 1 if not set. (optional) - name := "name_example" // string | Name of next available address blocks. (optional) - comment := "comment_example" // string | Comment of next available address blocks. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableAB(context.Background(), id).Cidr(cidr).Count(count).Name(name).Comment(comment).Execute() + resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableAB(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.ListNextAvailableAB``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -590,16 +562,15 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListNextAvailableABRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIListNextAvailableABRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **cidr** | **int32** | The cidr value of address blocks to be created. | - **count** | **int32** | Number of address blocks to generate. Default 1 if not set. | - **name** | **string** | Name of next available address blocks. | - **comment** | **string** | Comment of next available address blocks. | +**cidr** | **int32** | The cidr value of address blocks to be created. | +**count** | **int32** | Number of address blocks to generate. Default 1 if not set. | +**name** | **string** | Name of next available address blocks. | +**comment** | **string** | Comment of next available address blocks. | ### Return type @@ -641,12 +612,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.ListNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -666,14 +635,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIListNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | ### Return type @@ -715,15 +683,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - cidr := int32(56) // int32 | The cidr value of subnets to be created. (optional) - count := int32(56) // int32 | Number of subnets to generate. Default 1 if not set. (optional) - name := "name_example" // string | Name of next available subnets. (optional) - comment := "comment_example" // string | Comment of next available subnets. (optional) - dhcpHost := "dhcpHost_example" // string | Reference of OnPrem Host associated with the next available subnets to be created. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableSubnet(context.Background(), id).Cidr(cidr).Count(count).Name(name).Comment(comment).DhcpHost(dhcpHost).Execute() + resp, r, err := apiClient.AddressBlockAPI.ListNextAvailableSubnet(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.ListNextAvailableSubnet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -743,17 +706,16 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListNextAvailableSubnetRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIListNextAvailableSubnetRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **cidr** | **int32** | The cidr value of subnets to be created. | - **count** | **int32** | Number of subnets to generate. Default 1 if not set. | - **name** | **string** | Name of next available subnets. | - **comment** | **string** | Comment of next available subnets. | - **dhcpHost** | **string** | Reference of OnPrem Host associated with the next available subnets to be created. | +**cidr** | **int32** | The cidr value of subnets to be created. | +**count** | **int32** | Number of subnets to generate. Default 1 if not set. | +**name** | **string** | Name of next available subnets. | +**comment** | **string** | Comment of next available subnets. | +**dhcpHost** | **string** | Reference of OnPrem Host associated with the next available subnets to be created. | ### Return type @@ -795,12 +757,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.AddressBlockAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -820,14 +780,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -869,12 +828,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewAddressBlock() // AddressBlock | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AddressBlockAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.AddressBlockAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AddressBlockAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -894,14 +852,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AddressBlockAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**AddressBlock**](AddressBlock.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**AddressBlock**](AddressBlock.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/ipam/docs/AsmAPI.md b/ipam/docs/AsmAPI.md index 3a46b28..ed683c7 100644 --- a/ipam/docs/AsmAPI.md +++ b/ipam/docs/AsmAPI.md @@ -51,12 +51,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AsmAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ASM**](ASM.md) | | +**body** | [**ASM**](ASM.md) | | ### Return type @@ -98,11 +98,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - subnetId := "subnetId_example" // string | (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AsmAPI.List(context.Background()).Fields(fields).SubnetId(subnetId).Execute() + resp, r, err := apiClient.AsmAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AsmAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -118,13 +116,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AsmAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **subnetId** | **string** | | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**subnetId** | **string** | | ### Return type @@ -166,11 +164,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.AsmAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.AsmAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AsmAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -190,13 +187,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `AsmAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type diff --git a/ipam/docs/DhcpHostAPI.md b/ipam/docs/DhcpHostAPI.md index 76bee00..7b2fa1b 100644 --- a/ipam/docs/DhcpHostAPI.md +++ b/ipam/docs/DhcpHostAPI.md @@ -33,17 +33,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.DhcpHostAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.DhcpHostAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DhcpHostAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -59,19 +51,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DhcpHostAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -113,7 +105,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() resp, r, err := apiClient.DhcpHostAPI.ListAssociations(context.Background(), id).Execute() @@ -136,13 +128,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListAssociationsRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DhcpHostAPIListAssociationsRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**HostAssociationsResponse**](HostAssociationsResponse.md) @@ -183,11 +174,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.DhcpHostAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.DhcpHostAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DhcpHostAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -207,13 +197,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DhcpHostAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -255,7 +244,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewHost() // Host | apiClient := ipam.NewAPIClient() @@ -279,13 +268,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DhcpHostAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Host**](Host.md) | | +**body** | [**Host**](Host.md) | | ### Return type diff --git a/ipam/docs/DnsUsageAPI.md b/ipam/docs/DnsUsageAPI.md index 525b6c2..0bb3607 100644 --- a/ipam/docs/DnsUsageAPI.md +++ b/ipam/docs/DnsUsageAPI.md @@ -31,15 +31,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.DnsUsageAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Execute() + resp, r, err := apiClient.DnsUsageAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DnsUsageAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -55,17 +49,17 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DnsUsageAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | ### Return type @@ -107,11 +101,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.DnsUsageAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.DnsUsageAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DnsUsageAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -131,13 +124,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `DnsUsageAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type diff --git a/ipam/docs/FilterAPI.md b/ipam/docs/FilterAPI.md index 37d4ef7..e2e0ddc 100644 --- a/ipam/docs/FilterAPI.md +++ b/ipam/docs/FilterAPI.md @@ -30,17 +30,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.FilterAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.FilterAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FilterAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -56,19 +48,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FilterAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type diff --git a/ipam/docs/FixedAddressAPI.md b/ipam/docs/FixedAddressAPI.md index 2222a03..3ec727f 100644 --- a/ipam/docs/FixedAddressAPI.md +++ b/ipam/docs/FixedAddressAPI.md @@ -35,10 +35,9 @@ import ( func main() { body := *ipam.NewFixedAddress("192.168.1.10", "mac", "00:0a:95:9d:68:16") // FixedAddress | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.FixedAddressAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.FixedAddressAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -54,13 +53,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FixedAddressAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**FixedAddress**](FixedAddress.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**FixedAddress**](FixedAddress.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -102,7 +101,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.FixedAddressAPI.Delete(context.Background(), id).Execute() @@ -123,13 +122,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FixedAddressAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -170,18 +168,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.FixedAddressAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.FixedAddressAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -197,20 +186,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FixedAddressAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -252,12 +241,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.FixedAddressAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.FixedAddressAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -277,14 +264,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FixedAddressAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -326,12 +312,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewFixedAddress("192.168.1.10", "mac", "00:0a:95:9d:68:16") // FixedAddress | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.FixedAddressAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.FixedAddressAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -351,14 +336,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `FixedAddressAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**FixedAddress**](FixedAddress.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**FixedAddress**](FixedAddress.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/ipam/docs/GlobalAPI.md b/ipam/docs/GlobalAPI.md index fd49f43..78ec5b1 100644 --- a/ipam/docs/GlobalAPI.md +++ b/ipam/docs/GlobalAPI.md @@ -33,10 +33,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.GlobalAPI.Read(context.Background()).Fields(fields).Execute() + resp, r, err := apiClient.GlobalAPI.Read(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GlobalAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -52,12 +51,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -99,11 +98,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.GlobalAPI.ReadById(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.GlobalAPI.ReadById(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GlobalAPI.ReadById``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -123,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadByIdRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIReadByIdRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -190,12 +187,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Global**](Global.md) | | +**body** | [**Global**](Global.md) | | ### Return type @@ -237,7 +234,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewGlobal() // Global | apiClient := ipam.NewAPIClient() @@ -261,13 +258,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateByIdRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GlobalAPIUpdateByIdRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Global**](Global.md) | | +**body** | [**Global**](Global.md) | | ### Return type diff --git a/ipam/docs/HaGroupAPI.md b/ipam/docs/HaGroupAPI.md index 15bd741..84a8e28 100644 --- a/ipam/docs/HaGroupAPI.md +++ b/ipam/docs/HaGroupAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HaGroupAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**HAGroup**](HAGroup.md) | | +**body** | [**HAGroup**](HAGroup.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.HaGroupAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HaGroupAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,18 +167,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - collectStats := true // bool | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.HaGroupAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).CollectStats(collectStats).Execute() + resp, r, err := apiClient.HaGroupAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HaGroupAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -195,20 +185,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HaGroupAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **collectStats** | **bool** | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**collectStats** | **bool** | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. | ### Return type @@ -250,12 +240,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - collectStats := true // bool | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.HaGroupAPI.Read(context.Background(), id).Fields(fields).CollectStats(collectStats).Execute() + resp, r, err := apiClient.HaGroupAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HaGroupAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -275,14 +263,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HaGroupAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **collectStats** | **bool** | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**collectStats** | **bool** | collect_stats gets the HA group stats(state, status, heartbeat) if set to _true_ in the _GET_ _/dhcp/ha_group_ request. | ### Return type @@ -324,7 +311,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewHAGroup([]ipam.HAGroupHost{*ipam.NewHAGroupHost("dhcp/host/8b02a7a2-fef0-4717-a616-095ef2afadcd")}, "Example HA Group") // HAGroup | apiClient := ipam.NewAPIClient() @@ -348,13 +335,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HaGroupAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**HAGroup**](HAGroup.md) | | +**body** | [**HAGroup**](HAGroup.md) | | ### Return type diff --git a/ipam/docs/HardwareFilterAPI.md b/ipam/docs/HardwareFilterAPI.md index 43861f8..7b25c97 100644 --- a/ipam/docs/HardwareFilterAPI.md +++ b/ipam/docs/HardwareFilterAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HardwareFilterAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**HardwareFilter**](HardwareFilter.md) | | +**body** | [**HardwareFilter**](HardwareFilter.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.HardwareFilterAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HardwareFilterAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.HardwareFilterAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.HardwareFilterAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HardwareFilterAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HardwareFilterAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.HardwareFilterAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.HardwareFilterAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HardwareFilterAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HardwareFilterAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewHardwareFilter("Example Hardware Filter") // HardwareFilter | apiClient := ipam.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `HardwareFilterAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**HardwareFilter**](HardwareFilter.md) | | +**body** | [**HardwareFilter**](HardwareFilter.md) | | ### Return type diff --git a/ipam/docs/IpSpaceAPI.md b/ipam/docs/IpSpaceAPI.md index 53494fa..88182f4 100644 --- a/ipam/docs/IpSpaceAPI.md +++ b/ipam/docs/IpSpaceAPI.md @@ -55,12 +55,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiBulkCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPIBulkCopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**BulkCopyIPSpace**](BulkCopyIPSpace.md) | | +**body** | [**BulkCopyIPSpace**](BulkCopyIPSpace.md) | | ### Return type @@ -102,7 +102,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewCopyIPSpace("Example IP Space") // CopyIPSpace | apiClient := ipam.NewAPIClient() @@ -126,13 +126,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPICopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**CopyIPSpace**](CopyIPSpace.md) | | +**body** | [**CopyIPSpace**](CopyIPSpace.md) | | ### Return type @@ -175,10 +174,9 @@ import ( func main() { body := *ipam.NewIPSpace("Example IP Space") // IPSpace | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpSpaceAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.IpSpaceAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpSpaceAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,13 +192,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**IPSpace**](IPSpace.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**IPSpace**](IPSpace.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -242,7 +240,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.IpSpaceAPI.Delete(context.Background(), id).Execute() @@ -263,13 +261,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -310,18 +307,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpSpaceAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.IpSpaceAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpSpaceAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -337,20 +325,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -392,12 +380,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpSpaceAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.IpSpaceAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpSpaceAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -417,14 +403,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -466,12 +451,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewIPSpace("Example IP Space") // IPSpace | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpSpaceAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.IpSpaceAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpSpaceAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -491,14 +475,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpSpaceAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**IPSpace**](IPSpace.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**IPSpace**](IPSpace.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/ipam/docs/IpamHostAPI.md b/ipam/docs/IpamHostAPI.md index 61982c6..794d16b 100644 --- a/ipam/docs/IpamHostAPI.md +++ b/ipam/docs/IpamHostAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpamHostAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**IpamHost**](IpamHost.md) | | +**body** | [**IpamHost**](IpamHost.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.IpamHostAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpamHostAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpamHostAPI.List(context.Background()).Fields(fields).OrderBy(orderBy).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.IpamHostAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpamHostAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpamHostAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -248,12 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.IpamHostAPI.Read(context.Background(), id).OrderBy(orderBy).Fields(fields).Execute() + resp, r, err := apiClient.IpamHostAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IpamHostAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -273,14 +262,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpamHostAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -322,7 +310,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewIpamHost("Example IPAM Host") // IpamHost | apiClient := ipam.NewAPIClient() @@ -346,13 +334,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `IpamHostAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**IpamHost**](IpamHost.md) | | +**body** | [**IpamHost**](IpamHost.md) | | ### Return type diff --git a/ipam/docs/LeasesCommandAPI.md b/ipam/docs/LeasesCommandAPI.md index 7ada1d3..b8c4b38 100644 --- a/ipam/docs/LeasesCommandAPI.md +++ b/ipam/docs/LeasesCommandAPI.md @@ -49,12 +49,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `LeasesCommandAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LeasesCommand**](LeasesCommand.md) | | +**body** | [**LeasesCommand**](LeasesCommand.md) | | ### Return type diff --git a/ipam/docs/OptionCodeAPI.md b/ipam/docs/OptionCodeAPI.md index dc6b4ea..26b6eb8 100644 --- a/ipam/docs/OptionCodeAPI.md +++ b/ipam/docs/OptionCodeAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionCodeAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OptionCode**](OptionCode.md) | | +**body** | [**OptionCode**](OptionCode.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.OptionCodeAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionCodeAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,15 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionCodeAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Execute() + resp, r, err := apiClient.OptionCodeAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionCodeAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -192,17 +185,17 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionCodeAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | ### Return type @@ -244,11 +237,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionCodeAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.OptionCodeAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionCodeAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -268,13 +260,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionCodeAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -316,7 +307,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewOptionCode(int64(15), "Example Option Code", "ipam/ip_space/8b02a7a2-fef0-4717-a616-095ef2afadcd", "fqdn") // OptionCode | apiClient := ipam.NewAPIClient() @@ -340,13 +331,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionCodeAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**OptionCode**](OptionCode.md) | | +**body** | [**OptionCode**](OptionCode.md) | | ### Return type diff --git a/ipam/docs/OptionFilterAPI.md b/ipam/docs/OptionFilterAPI.md index ca4c654..e3935ee 100644 --- a/ipam/docs/OptionFilterAPI.md +++ b/ipam/docs/OptionFilterAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionFilterAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OptionFilter**](OptionFilter.md) | | +**body** | [**OptionFilter**](OptionFilter.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.OptionFilterAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionFilterAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionFilterAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.OptionFilterAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionFilterAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionFilterAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionFilterAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.OptionFilterAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionFilterAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionFilterAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewOptionFilter("Example Option Filter", *ipam.NewOptionFilterRuleList()) // OptionFilter | apiClient := ipam.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionFilterAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**OptionFilter**](OptionFilter.md) | | +**body** | [**OptionFilter**](OptionFilter.md) | | ### Return type diff --git a/ipam/docs/OptionGroupAPI.md b/ipam/docs/OptionGroupAPI.md index 265a5b6..229d218 100644 --- a/ipam/docs/OptionGroupAPI.md +++ b/ipam/docs/OptionGroupAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionGroupAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OptionGroup**](OptionGroup.md) | | +**body** | [**OptionGroup**](OptionGroup.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.OptionGroupAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionGroupAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionGroupAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.OptionGroupAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionGroupAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionGroupAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionGroupAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.OptionGroupAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionGroupAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionGroupAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewOptionGroup("Example Option Group") // OptionGroup | apiClient := ipam.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionGroupAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**OptionGroup**](OptionGroup.md) | | +**body** | [**OptionGroup**](OptionGroup.md) | | ### Return type diff --git a/ipam/docs/OptionSpaceAPI.md b/ipam/docs/OptionSpaceAPI.md index 1c7c4ac..eaf35cf 100644 --- a/ipam/docs/OptionSpaceAPI.md +++ b/ipam/docs/OptionSpaceAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionSpaceAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OptionSpace**](OptionSpace.md) | | +**body** | [**OptionSpace**](OptionSpace.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.OptionSpaceAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionSpaceAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionSpaceAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Execute() + resp, r, err := apiClient.OptionSpaceAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionSpaceAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionSpaceAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.OptionSpaceAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.OptionSpaceAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OptionSpaceAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionSpaceAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewOptionSpace("Example Option Space") // OptionSpace | apiClient := ipam.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `OptionSpaceAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**OptionSpace**](OptionSpace.md) | | +**body** | [**OptionSpace**](OptionSpace.md) | | ### Return type diff --git a/ipam/docs/RangeAPI.md b/ipam/docs/RangeAPI.md index 1bd2cfc..ef6ad16 100644 --- a/ipam/docs/RangeAPI.md +++ b/ipam/docs/RangeAPI.md @@ -37,10 +37,9 @@ import ( func main() { body := *ipam.NewRange("10.0.0.10", "10.0.0.0") // Range | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.RangeAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -56,13 +55,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Range**](Range.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Range**](Range.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -104,12 +103,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) (default to false) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) (default to 1) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.CreateNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.RangeAPI.CreateNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.CreateNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -129,14 +126,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPICreateNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] ### Return type @@ -178,7 +174,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.RangeAPI.Delete(context.Background(), id).Execute() @@ -199,13 +195,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -246,18 +241,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.RangeAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -273,20 +259,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -328,12 +314,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.ListNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.RangeAPI.ListNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.ListNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -353,14 +337,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPIListNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | ### Return type @@ -402,12 +385,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.RangeAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -427,14 +408,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -476,12 +456,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewRange("10.0.0.10", "10.0.0.0") // Range | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.RangeAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.RangeAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RangeAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -501,14 +480,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `RangeAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Range**](Range.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Range**](Range.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/ipam/docs/ServerAPI.md b/ipam/docs/ServerAPI.md index 52bf7c6..9946972 100644 --- a/ipam/docs/ServerAPI.md +++ b/ipam/docs/ServerAPI.md @@ -35,10 +35,9 @@ import ( func main() { body := *ipam.NewServer("Example DHCP Config Profile") // Server | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -54,13 +53,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Server**](Server.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Server**](Server.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -102,7 +101,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.ServerAPI.Delete(context.Background(), id).Execute() @@ -123,13 +122,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -170,18 +168,9 @@ import ( ) func main() { - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.ServerAPI.List(context.Background()).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -197,20 +186,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -252,12 +241,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -277,14 +264,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -326,12 +312,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewServer("Example DHCP Config Profile") // Server | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.ServerAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.ServerAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServerAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -351,14 +336,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `ServerAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Server**](Server.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Server**](Server.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/ipam/docs/SubnetAPI.md b/ipam/docs/SubnetAPI.md index 022810f..710901b 100644 --- a/ipam/docs/SubnetAPI.md +++ b/ipam/docs/SubnetAPI.md @@ -37,7 +37,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewCopySubnet("ipam/ip_space/59882b4a-427a-4077-a9b4-f08cb2b97318") // CopySubnet | apiClient := ipam.NewAPIClient() @@ -61,13 +61,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCopyRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPICopyRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**CopySubnet**](CopySubnet.md) | | +**body** | [**CopySubnet**](CopySubnet.md) | | ### Return type @@ -110,10 +109,9 @@ import ( func main() { body := *ipam.NewSubnet() // Subnet | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.Create(context.Background()).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.SubnetAPI.Create(context.Background()).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.Create``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -129,13 +127,13 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Subnet**](Subnet.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Subnet**](Subnet.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -177,12 +175,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) (default to false) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) (default to 1) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.CreateNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.SubnetAPI.CreateNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.CreateNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -202,14 +198,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiCreateNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPICreateNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | [default to false] +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | [default to 1] ### Return type @@ -251,7 +246,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() r, err := apiClient.SubnetAPI.Delete(context.Background(), id).Execute() @@ -272,13 +267,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -319,18 +313,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute() + resp, r, err := apiClient.SubnetAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -346,20 +331,20 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **torderBy** | **string** | This parameter is used for sorting by tags. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**torderBy** | **string** | This parameter is used for sorting by tags. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -401,12 +386,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - contiguous := true // bool | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. (optional) - count := int32(56) // int32 | The number of IP addresses requested. Defaults to 1. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.ListNextAvailableIP(context.Background(), id).Contiguous(contiguous).Count(count).Execute() + resp, r, err := apiClient.SubnetAPI.ListNextAvailableIP(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.ListNextAvailableIP``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -426,14 +409,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiListNextAvailableIPRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPIListNextAvailableIPRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | - **count** | **int32** | The number of IP addresses requested. Defaults to 1. | +**contiguous** | **bool** | Indicates whether the IP addresses should belong to a contiguous block. Defaults to _false_. | +**count** | **int32** | The number of IP addresses requested. Defaults to 1. | ### Return type @@ -475,12 +457,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.Read(context.Background(), id).Fields(fields).Inherit(inherit).Execute() + resp, r, err := apiClient.SubnetAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -500,14 +480,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type @@ -549,12 +528,11 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *ipam.NewSubnet() // Subnet | - inherit := "inherit_example" // string | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none (optional) apiClient := ipam.NewAPIClient() - resp, r, err := apiClient.SubnetAPI.Update(context.Background(), id).Body(body).Inherit(inherit).Execute() + resp, r, err := apiClient.SubnetAPI.Update(context.Background(), id).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SubnetAPI.Update``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -574,14 +552,13 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `SubnetAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**Subnet**](Subnet.md) | | - **inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | +**body** | [**Subnet**](Subnet.md) | | +**inherit** | **string** | This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | ### Return type diff --git a/keys/README.md b/keys/README.md index ee2bb14..d6a2987 100644 --- a/keys/README.md +++ b/keys/README.md @@ -10,7 +10,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: v1 - Package version: 1.0.0 - Generator version: 7.5.0 -- Build package: org.openapitools.codegen.languages.GoClientCodegen +- Build package: com.infoblox.codegen.BloxoneGoClientCodegen ## Installation diff --git a/keys/docs/GenerateTsigAPI.md b/keys/docs/GenerateTsigAPI.md index c5c6149..df0fe73 100644 --- a/keys/docs/GenerateTsigAPI.md +++ b/keys/docs/GenerateTsigAPI.md @@ -30,10 +30,9 @@ import ( ) func main() { - algorithm := "algorithm_example" // string | The TSIG key algorithm. Valid values are: * _hmac_sha256_ * _hmac_sha1_ * _hmac_sha224_ * _hmac_sha384_ * _hmac_sha512_ Defaults to _hmac_sha256_. (optional) apiClient := keys.NewAPIClient() - resp, r, err := apiClient.GenerateTsigAPI.GenerateTSIG(context.Background()).Algorithm(algorithm).Execute() + resp, r, err := apiClient.GenerateTsigAPI.GenerateTSIG(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GenerateTsigAPI.GenerateTSIG``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,12 +48,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiGenerateTSIGRequest struct via the builder pattern +Other parameters are passed through a pointer to a `GenerateTsigAPIGenerateTSIGRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **algorithm** | **string** | The TSIG key algorithm. Valid values are: * _hmac_sha256_ * _hmac_sha1_ * _hmac_sha224_ * _hmac_sha384_ * _hmac_sha512_ Defaults to _hmac_sha256_. | +**algorithm** | **string** | The TSIG key algorithm. Valid values are: * _hmac_sha256_ * _hmac_sha1_ * _hmac_sha224_ * _hmac_sha384_ * _hmac_sha512_ Defaults to _hmac_sha256_. | ### Return type diff --git a/keys/docs/KerberosAPI.md b/keys/docs/KerberosAPI.md index 9b3818d..0e35b8f 100644 --- a/keys/docs/KerberosAPI.md +++ b/keys/docs/KerberosAPI.md @@ -33,7 +33,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := keys.NewAPIClient() r, err := apiClient.KerberosAPI.Delete(context.Background(), id).Execute() @@ -54,13 +54,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `KerberosAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -101,17 +100,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := keys.NewAPIClient() - resp, r, err := apiClient.KerberosAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.KerberosAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -127,19 +118,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `KerberosAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -181,11 +172,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := keys.NewAPIClient() - resp, r, err := apiClient.KerberosAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.KerberosAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -205,13 +195,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `KerberosAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -253,7 +242,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *keys.NewKerberosKey() // KerberosKey | apiClient := keys.NewAPIClient() @@ -277,13 +266,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `KerberosAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**KerberosKey**](KerberosKey.md) | | +**body** | [**KerberosKey**](KerberosKey.md) | | ### Return type diff --git a/keys/docs/TsigAPI.md b/keys/docs/TsigAPI.md index 3d359bf..da432f2 100644 --- a/keys/docs/TsigAPI.md +++ b/keys/docs/TsigAPI.md @@ -53,12 +53,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `TsigAPICreateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**TSIGKey**](TSIGKey.md) | | +**body** | [**TSIGKey**](TSIGKey.md) | | ### Return type @@ -100,7 +100,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := keys.NewAPIClient() r, err := apiClient.TsigAPI.Delete(context.Background(), id).Execute() @@ -121,13 +121,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern +Other parameters are passed through a pointer to a `TsigAPIDeleteRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type (empty response body) @@ -168,17 +167,9 @@ import ( ) func main() { - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) - filter := "filter_example" // string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | (optional) - offset := int32(56) // int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. (optional) - limit := int32(56) // int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. (optional) - pageToken := "pageToken_example" // string | The service-defined string used to identify a page of resources. A null value indicates the first page. (optional) - orderBy := "orderBy_example" // string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. (optional) - tfilter := "tfilter_example" // string | This parameter is used for filtering by tags. (optional) - torderBy := "torderBy_example" // string | This parameter is used for sorting by tags. (optional) apiClient := keys.NewAPIClient() - resp, r, err := apiClient.TsigAPI.List(context.Background()).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute() + resp, r, err := apiClient.TsigAPI.List(context.Background()).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TsigAPI.List``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -194,19 +185,19 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern +Other parameters are passed through a pointer to a `TsigAPIListRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | - **filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | - **offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | - **limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | - **pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | - **orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | - **tfilter** | **string** | This parameter is used for filtering by tags. | - **torderBy** | **string** | This parameter is used for sorting by tags. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**filter** | **string** | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | +**offset** | **int32** | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | +**limit** | **int32** | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | +**pageToken** | **string** | The service-defined string used to identify a page of resources. A null value indicates the first page. | +**orderBy** | **string** | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | +**tfilter** | **string** | This parameter is used for filtering by tags. | +**torderBy** | **string** | This parameter is used for sorting by tags. | ### Return type @@ -248,11 +239,10 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource - fields := "fields_example" // string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. (optional) + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource apiClient := keys.NewAPIClient() - resp, r, err := apiClient.TsigAPI.Read(context.Background(), id).Fields(fields).Execute() + resp, r, err := apiClient.TsigAPI.Read(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TsigAPI.Read``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -272,13 +262,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiReadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `TsigAPIReadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | +**fields** | **string** | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | ### Return type @@ -320,7 +309,7 @@ import ( ) func main() { - id := "id_example" // string | An application specific resource identity of a resource + id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource body := *keys.NewTSIGKey("test.key.com.", "bGVzYnJvbnplc2ZvbnRkdXNraQ==") // TSIGKey | apiClient := keys.NewAPIClient() @@ -344,13 +333,12 @@ Name | Type | Description | Notes ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern +Other parameters are passed through a pointer to a `TsigAPIUpdateRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**TSIGKey**](TSIGKey.md) | | +**body** | [**TSIGKey**](TSIGKey.md) | | ### Return type diff --git a/keys/docs/UploadAPI.md b/keys/docs/UploadAPI.md index 8f000b8..faafd77 100644 --- a/keys/docs/UploadAPI.md +++ b/keys/docs/UploadAPI.md @@ -49,12 +49,12 @@ func main() { ### Other Parameters -Other parameters are passed through a pointer to a apiUploadRequest struct via the builder pattern +Other parameters are passed through a pointer to a `UploadAPIUploadRequest` struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UploadRequest**](UploadRequest.md) | | +**body** | [**UploadRequest**](UploadRequest.md) | | ### Return type