From 042678a6d78bb579bb311dc1fc8903f9150ab04a Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Sun, 23 Mar 2025 13:11:27 +0100 Subject: [PATCH] Add usage examples for CfDnsClient in API documentation Expanded the API documentation by including practical examples for the `CfDnsClient` class. Updated Javadoc metadata and modified the index.html title for better context. --- docs/apidocs/allclasses-index.html | 4 +-- docs/apidocs/allpackages-index.html | 4 +-- .../codes/thischwa/cf/CfDnsClient.html | 26 ++++++++++++++++--- docs/apidocs/codes/thischwa/cf/CfRequest.html | 4 +-- .../thischwa/cf/CloudflareApiException.html | 4 +-- .../cf/CloudflareNotFoundException.html | 4 +-- .../thischwa/cf/class-use/CfDnsClient.html | 4 +-- .../thischwa/cf/class-use/CfRequest.html | 4 +-- .../cf/class-use/CloudflareApiException.html | 4 +-- .../CloudflareNotFoundException.html | 4 +-- .../thischwa/cf/model/AbstractEntity.html | 4 +-- .../cf/model/AbstractMultipleResponse.html | 4 +-- .../thischwa/cf/model/AbstractResponse.html | 4 +-- .../cf/model/AbstractSingleResponse.html | 4 +-- .../thischwa/cf/model/PagingRequest.html | 4 +-- .../codes/thischwa/cf/model/RecordEntity.html | 4 +-- .../cf/model/RecordMultipleResponse.html | 4 +-- .../cf/model/RecordSingleResponse.html | 4 +-- .../codes/thischwa/cf/model/RecordType.html | 4 +-- .../thischwa/cf/model/ResponseEntity.html | 4 +-- .../codes/thischwa/cf/model/ResultInfo.html | 4 +-- .../codes/thischwa/cf/model/ZoneEntity.html | 4 +-- .../cf/model/ZoneMultipleResponse.html | 4 +-- .../cf/model/class-use/AbstractEntity.html | 4 +-- .../class-use/AbstractMultipleResponse.html | 4 +-- .../cf/model/class-use/AbstractResponse.html | 4 +-- .../class-use/AbstractSingleResponse.html | 4 +-- .../cf/model/class-use/PagingRequest.html | 4 +-- .../cf/model/class-use/RecordEntity.html | 4 +-- .../class-use/RecordMultipleResponse.html | 4 +-- .../model/class-use/RecordSingleResponse.html | 4 +-- .../cf/model/class-use/RecordType.html | 4 +-- .../cf/model/class-use/ResponseEntity.html | 4 +-- .../cf/model/class-use/ResultInfo.html | 4 +-- .../cf/model/class-use/ZoneEntity.html | 4 +-- .../model/class-use/ZoneMultipleResponse.html | 4 +-- .../thischwa/cf/model/package-summary.html | 4 +-- .../codes/thischwa/cf/model/package-tree.html | 4 +-- .../codes/thischwa/cf/model/package-use.html | 4 +-- .../codes/thischwa/cf/package-summary.html | 4 +-- .../codes/thischwa/cf/package-tree.html | 4 +-- .../codes/thischwa/cf/package-use.html | 4 +-- docs/apidocs/help-doc.html | 4 +-- docs/apidocs/index-all.html | 4 +-- docs/apidocs/index.html | 4 +-- docs/apidocs/overview-summary.html | 4 +-- docs/apidocs/overview-tree.html | 4 +-- docs/apidocs/search.html | 4 +-- docs/apidocs/serialized-form.html | 4 +-- docs/index.html | 4 +-- 50 files changed, 121 insertions(+), 101 deletions(-) diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html index 4dc1605..4845ac8 100644 --- a/docs/apidocs/allclasses-index.html +++ b/docs/apidocs/allclasses-index.html @@ -1,11 +1,11 @@ - + Alle Klassen und Schnittstellen (CloudflareDNS-java 0.1.0-SNAPSHOT API) - + diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html index 477e736..79a0a82 100644 --- a/docs/apidocs/allpackages-index.html +++ b/docs/apidocs/allpackages-index.html @@ -1,11 +1,11 @@ - + Alle Packages (CloudflareDNS-java 0.1.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html index 3fd9d13..72b6cef 100644 --- a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html @@ -1,11 +1,11 @@ - + CfDnsClient (CloudflareDNS-java 0.1.0-SNAPSHOT API) - + @@ -95,7 +95,27 @@ loadScripts(document, 'script'); extends Object
CfDnsClient is a client interface to interact with Cloudflare DNS service. It allows managing DNS records and zones within the Cloudflare system, including creating, updating, retrieving, and - deleting DNS records.
+ deleting DNS records. + +

Example: + 


+ // Create a new CfDnsClient instance
+ CfDnsClient client = new CfDnsClient(
+     "email@example.com",
+     "yourApiKey",
+     "yourApiToken"
+ );
+
+ // Retrieve a zone
+ ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
+ System.out.println("Zone ID: " + zone.getId());
+
+ // Retrieve records of a zone
+ List records = cfDnsClient.sldListAll(zone, "sld");
+ records.forEach(record ->
+     System.out.println("Record Type: " + record.getType() + ", Value: " + record.getContent())
+ );
+