Update README formatting and enhance Javadoc examples
Standardized README parameter formatting for consistency. Enhanced Javadoc in `CfDnsClient` with new example for creating subdomain records.
This commit is contained in:
@@ -144,7 +144,7 @@ System.out.println("Record IP: " + record.getContent());
|
||||
Create a new DNS record in a specific zone.
|
||||
|
||||
- **Parameters**:
|
||||
- `ZoneEntity zone` - DNS zone object.
|
||||
- `ZoneEntity zone` - DNS zone object.
|
||||
- `String sld` - The sub-tld of the new record.
|
||||
- `int ttl` - The time-to-live in seconds of the new rcord.
|
||||
|
||||
|
||||
@@ -27,11 +27,14 @@ import lombok.extern.slf4j.Slf4j;
|
||||
* // Retrieve a zone
|
||||
* ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
|
||||
* System.out.println("Zone ID: " + zone.getId());
|
||||
* // Retrieve records of a zone
|
||||
* // Retrieve records of a subdomain
|
||||
* List<{@link RecordEntity}> records = cfDnsClient.sldListAll(zone, "sld");
|
||||
* records.forEach(record ->
|
||||
* System.out.println("Record Type: " + record.getType() + ", Value: " + record.getContent())
|
||||
* );
|
||||
* // Creat a record for the subdomain "api"
|
||||
* RecordEntity created = client.recordCreateSld(zone, "api", 60, RecordType.A, "192.168.1.1");
|
||||
* System.out.println("Created Record ID: " + created.getId());
|
||||
* </code></pre>
|
||||
*/
|
||||
@Setter
|
||||
|
||||
Reference in New Issue
Block a user