zone: make Owner fields optional #232
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomasqueirozb
force-pushed
the
owner-default-values
branch
from
f3bffd3 to
30c623c
Compare
thomasqueirozb
changed the title
This was referenced Jun 14, 2024
kennetheversole
pushed a commit
that referenced
this pull request
Jan 30, 2025
Does the following: - Removes the `multiple_railguns_allowed` field, as it appears to be removed. Fixes #236 - Makes the fields of the `owner` field optional (#232), as otherwise the examples would still not work - Adds the `activated_on` field There are some more discrepancies, i.e. fields on the docs that don't exist here, and fields here that don't exist in the docs, but I want to refrain from changing too much. This can be tested with the `cloudflare-examples` cli: <details> <summary>Before</summary> ``` $ cargo run --bin cloudflare-examples -- --auth-token=XXX zone XXX Compiling cloudflare v0.12.0 (/home/wp/programming/cloudflare-rs/cloudflare) Compiling cloudflare-examples v0.6.0 (/home/wp/programming/cloudflare-rs/cloudflare-examples) Finished dev [unoptimized + debuginfo] target(s) in 3.45s Running `target/debug/cloudflare-examples --auth-token=XXX zone XXX` Error: error decoding response body: missing field `multiple_railguns_allowed` at line 1 column 585 ``` </details> <details> <summary>After</summary> ``` $cargo run --bin cloudflare-examples -- --auth-token=XXX zone XXX Finished dev [unoptimized + debuginfo] target(s) in 0.11s Running `target/debug/cloudflare-examples --auth-token=XXX zone XXX` Success: ApiSuccess { result: Zone { id: "XXX", name: "XXX", account: AccountDetails { id: "XXX", name: "XXX", }, activated_on: 2021-08-22T18:52:08.877823Z, betas: None, created_on: 2021-08-22T18:48:11.312863Z, deactivation_reason: None, development_mode: 0, host: None, meta: Meta { custom_certificate_quota: 0, page_rule_quota: 3, phishing_detected: false, }, modified_on: 2021-08-22T18:52:08.877823Z, name_servers: [ "pedro.ns.cloudflare.com", "surina.ns.cloudflare.com", ], original_dnshost: None, original_name_servers: Some( [ "ns13.domaincontrol.com", "ns14.domaincontrol.com", ], ), original_registrar: Some( "namecheap, inc. (id: 1068)", ), owner: User { id: None, email: None, }, paused: false, permissions: [ "#dns_records:edit", "#dns_records:read", "#zone:read", ], plan: Some( Plan { id: "0feeeeeeeeeeeeeeeeeeeeeeeeeeeeee", name: "Free Website", price: 0.0, currency: "USD", frequency: Some( Nil, ), legacy_id: "free", is_subscribed: false, can_subscribe: false, }, ), plan_pending: None, status: Active, vanity_name_servers: None, zone_type: Full, }, result_info: None, messages: Array [], errors: [], } ``` </details>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
According to the docs
idandnameare not required andemailisn't even mentioned. My request hadidandemailas null, which broke deserializationThe correct thing to do would be to make these fieldsHad to convert the fields to Option, which breaks the public API, but I doubt anyone is using the Owner struct tbh.Option<String>but I didn't do so in order not to break the api.This is also how the go implementation does it too:
https://github.com/cloudflare/cloudflare-go/blob/325729d2e358cd3f300c130cfa828e5704e725d8/zone.go#L24-L29
If any of the fields are
null, the go json library will just make that field an empty string.