diff --git a/README.md b/README.md index bc7aeca..a539dbb 100644 --- a/README.md +++ b/README.md @@ -22,35 +22,7 @@ The project has its own maven repository. Follow the instructions on the latest ## Changelog -- 0.4.0: - - fixed some paging issues - - **Breaking Change**: renamed `client.zone().record()` to `client.zone().getRecord()` - - Code quality improvements: Increasing test coverage -- 0.3.0: - - **Breaking Change**: - - **New Fluent API**: Changed the initialization of the client(`new CfDnsClientBuilder().withApiTokenAuth("your-api-token").build()`) - - Authentication with API token. -- 0.2.0: - - **Breaking Change**: `emptyResultThrowsException` default changed from `true` to `false`. Now applies to both - single and multiple result requests. Empty results will be returned by default without throwing exceptions. - - API method names refactored for consistency: `zoneListAll` → `zoneList`, `zoneInfo` → `zoneGet`, `sldListAll` → - `recordList` - - RecordEntity getter methods renamed for clarity: `getName()` → `getSld()` - - **New Fluent API**: Changed the initialization of the client(`new CfDnsClientBuilder().withApiTokenAuth("your-api-token").build()`) and added chainable method interface for more readable DNS operations ( - `client.zone().record()...`) - - Code quality improvements: removed duplication in batch operations, improved type safety in HTTP methods, - optimized string concatenation, removed mutable setters from CfDnsClient - - Enhanced type validation in `RecordEntity.build()` with better error messages - - CfClient#recordList must return multiple RecordEntries - - add a missing source jar - - ResponseResultInfo#Errors: wrong object structure - - changing multiple records with put, post, patch and delete for dns-records -- 0.1.0: - - refactored / extended tests -- 0.1.0-beta.3: - - fixed json deserialization - - added logging of api errors -- 0.1.0-beta.1: 1st runnable version +See [changelog](changelog.md) ## Methods Overview @@ -438,7 +410,4 @@ try { ``` --- - -# Summary - -`CfDnsClient` offers a simple interface for managing DNS entries via Cloudflare's public API, allowing seamless CRUD operations and automation-friendly workflows. \ No newline at end of file + \ No newline at end of file diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..d926ef7 --- /dev/null +++ b/changelog.md @@ -0,0 +1,31 @@ +# Changelog + +- 0.4.0: + - fixed some paging issues + - **Breaking Change**: renamed `client.zone().record()` to `client.zone().getRecord()` + - Code quality improvements: Increasing test coverage +- 0.3.0: + - **Breaking Change**: + - **New Fluent API**: Changed the initialization of the client(`new CfDnsClientBuilder().withApiTokenAuth("your-api-token").build()`) + - Authentication with API token. +- 0.2.0: + - **Breaking Change**: `emptyResultThrowsException` default changed from `true` to `false`. Now applies to both + single and multiple result requests. Empty results will be returned by default without throwing exceptions. + - API method names refactored for consistency: `zoneListAll` → `zoneList`, `zoneInfo` → `zoneGet`, `sldListAll` → + `recordList` + - RecordEntity getter methods renamed for clarity: `getName()` → `getSld()` + - **New Fluent API**: Changed the initialization of the client(`new CfDnsClientBuilder().withApiTokenAuth("your-api-token").build()`) and added chainable method interface for more readable DNS operations ( + `client.zone().record()...`) + - Code quality improvements: removed duplication in batch operations, improved type safety in HTTP methods, + optimized string concatenation, removed mutable setters from CfDnsClient + - Enhanced type validation in `RecordEntity.build()` with better error messages + - CfClient#recordList must return multiple RecordEntries + - add a missing source jar + - ResponseResultInfo#Errors: wrong object structure + - changing multiple records with put, post, patch and delete for dns-records +- 0.1.0: + - refactored / extended tests +- 0.1.0-beta.3: + - fixed json deserialization + - added logging of api errors +- 0.1.0-beta.1: 1st runnable version \ No newline at end of file