- Reject base URLs containing user info, query strings, or fragments - Update README example and changelog to reflect the stricter policy - Adapt tests to use the private CfDnsClient constructor for local HTTP servers - Bump version from 1.0.0-rc.1-SNAPSHOT to 1.0.0-SNAPSHOT in pom.xml and changelog Co-authored-by: Junie <junie@jetbrains.com>
71 lines
6.5 KiB
Markdown
71 lines
6.5 KiB
Markdown
# Changelog
|
||
|
||
- 1.0.0-SNAPSHOT:
|
||
- **Breaking Changes**:
|
||
- `recordList` overloads replaced, because they were ambiguous (e.g. `recordList(zone, null)` didn't compile):
|
||
- `recordList(zone, String subdomain, RecordType... types)` and `recordList(zone, String subdomain)` → `recordListBySubdomain(zone, subdomain, types...)`
|
||
- `recordList(zone, RecordType... types)` → `recordListByType(zone, types...)`
|
||
- `recordList(zone)` and `recordList(zone, PagingRequest)` remain unchanged
|
||
- `CfDnsClient#recordCreateSld(...)` was removed; use `recordCreateSubdomain(...)`
|
||
- `PagingRequest` is now an immutable record with `page()` and `perPage()` accessors. The setters and `getPagingParams()` were removed; use `forRecords(...)`, `forZones(...)`, `next()` and `withPage(...)` instead.
|
||
- `PagingRequest.defaultPaging()` now requests 50 items instead of 1,000. Page numbers and page sizes are validated; zone requests accept 5–50 items per page, while DNS record requests accept 1–5,000,000.
|
||
- `withBaseUrl` only accepts HTTPS URLs, otherwise an `IllegalArgumentException` is thrown
|
||
- `build()` throws an `IllegalStateException` if no authentication was configured, `null` credentials throw an `IllegalArgumentException`
|
||
- zone names and subdomains with whitespace, control characters or `\ ? # & ; | < > " ' `` ` `` are rejected with an `IllegalArgumentException`, zone and record IDs must be alphanumeric
|
||
- timestamps of `RecordEntity` and `ZoneEntity` (`createdOn`, `modifiedOn`, `activatedOn`) are of type `java.time.Instant` instead of `LocalDateTime`, so the time zone (UTC) isn't lost anymore
|
||
- Cloudflare responses with HTTP status 404 throw a `CloudflareNotFoundException` (independent of `emptyResultThrowsException`)
|
||
- unexpected runtime exceptions aren't wrapped into a `CloudflareApiException("Unexpected error!")` anymore
|
||
- batch DELETE sends only the record IDs, batch PATCH sends all writable attributes which aren't `null` (before: only the content)
|
||
- security: query values (zone names, subdomains) are URL-encoded and IDs are validated, which prevents query parameter injection and path traversal
|
||
- Unicode subdomains are converted to Punycode before requests are sent
|
||
- connect and response timeouts (defaults: 10 s / 30 s), configurable via `withConnectTimeout` / `withResponseTimeout`
|
||
- `CfDnsClient` uses one shared HTTP client with connection pooling instead of a new one per request and implements `AutoCloseable`, call `close()` to release the connections
|
||
- `CloudflareApiException` provides the HTTP status code (`getStatusCode()`) and the errors reported by Cloudflare (`getErrors()`)
|
||
- `RecordEntity` supports the attributes `priority` (MX, URI), `data` (e.g. SRV incl. its priority, CAA), `comment` and `tags`; they are also considered by batch operations, as is `proxied`
|
||
- `recordCreate` and `recordUpdate` don't modify the given `RecordEntity` anymore and send only writable attributes
|
||
- fluent `update(content)` sends only the new content (partial update)
|
||
- filtering by exactly one record type is done by Cloudflare (`?type=`), unknown record types in responses don't break the client-side filter anymore
|
||
- updated dependencies: jackson 3.2.4, httpclient5 5.6.4, lombok 1.18.48, logback-classic 1.6.6, mockito-junit-jupiter 5.24.0
|
||
- updated maven plugins: maven-compiler-plugin 3.16.0, maven-surefire-plugin 3.6.0, maven-jar-plugin 3.5.1
|
||
- fixed "getRecord" wording in log and exception messages (e.g. "Invalid record type")
|
||
- **Deprecation**: the misleading term "sld" was renamed to "subdomain": `RecordEntity#getSld()` is deprecated for removal; use `RecordEntity#getSubdomain()`
|
||
- `getSubdomain()` returns `"@"` for the zone apex; `CfDnsClient.APEX` can be used to address the zone apex
|
||
- fixed: API errors were wrapped into a generic "Unexpected error!" exception
|
||
- fixed: `zoneGet` threw an `IndexOutOfBoundsException` for unknown zones, it now returns `null` or throws a `CloudflareNotFoundException` (depending on `emptyResultThrowsException`)
|
||
- fixed: `getSubdomain()` failed for apex records and records with multi-level subdomains, batch operations now send the full record name
|
||
- fixed: `zoneList()` and `recordList(...)` without `PagingRequest` returned only the first page, now all pages are fetched; `recordList(zone, null)` uses a page size of 1,000 to limit response memory use
|
||
- fixed: DNS records are listed with a stable order (`order=name`), because without it Cloudflare's pages can overlap and miss records; fetched records are de-duplicated and inconsistent pages are fetched again
|
||
- fixed: `recordDelete` threw a `NullPointerException` for an empty result
|
||
- 0.5.0:
|
||
- moved the project to git.mein-gateway.de
|
||
- replaced sonarqube with own actions
|
||
- migrate to jackson 3.x
|
||
- 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 |