Allow DNSForwardingSettings to become partial#36
Merged
shyouhei merged 3 commits intoJul 7, 2026
Merged
Conversation
Signed-off-by: 卜部 昌平 <s-urabe@sakura.ad.jp>
…g.yaml ./openapi/openapi.json Signed-off-by: 卜部 昌平 <s-urabe@sakura.ad.jp>
Signed-off-by: 卜部 昌平 <s-urabe@sakura.ad.jp>
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAPI schema and regenerated Go types/JSON codecs so ModelsSettingsDNSForwardingSettings can be decoded from “partial” server responses (e.g., when DNS private hosted zone is disabled and only Enabled is returned).
Changes:
- Relax
Models.Settings.DNSForwardingSettingsrequired fields inopenapi.json(onlyEnabledremains required). - Regenerate Go models/codecs so
PrivateHostedZone/UpstreamDNS1/UpstreamDNS2become optional (OptString) and are conditionally encoded. - Update examples/tests to construct the optional string fields via
NewOptString.
Reviewed changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
seg_test.go |
Updates test input construction to use OptString fields. |
example_test.go |
Updates example code to use NewOptString for optional DNS forwarding fields. |
openapi/openapi.json |
Makes DNS forwarding fields optional in the schema (only Enabled required). |
apis/v1/oas_schemas_gen.go |
Regenerates model struct: DNS forwarding string fields become OptString (public API surface change). |
apis/v1/oas_json_gen.go |
Regenerates JSON encode/decode logic to omit unset optional fields and relax required-field validation. |
apis/v1/oas_faker_gen.go |
Updates faker to populate OptString fields via SetFake(). |
apis/v1/oas_test_examples_gen_test.go |
Regenerated tests; import ordering change needs goimports/gofmt compliance fix. |
Files not reviewed (4)
- apis/v1/oas_faker_gen.go: Generated file
- apis/v1/oas_json_gen.go: Generated file
- apis/v1/oas_schemas_gen.go: Generated file
- apis/v1/oas_test_examples_gen_test.go: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
19
to
23
| import ( | ||
| std "encoding/json" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/go-faster/errors" | ||
| "github.com/go-faster/jx" |
Member
Author
There was a problem hiding this comment.
This file is auto generated. We're not going to touch it.
Comment on lines
1954
to
1958
| "Models.Settings.DNSForwardingSettings": { | ||
| "type": "object", | ||
| "required": [ | ||
| "Enabled", | ||
| "PrivateHostedZone", | ||
| "UpstreamDNS1", | ||
| "UpstreamDNS2" | ||
| "Enabled" | ||
| ], |
Member
Author
There was a problem hiding this comment.
This is something optional that we don't plan to do.
Comment on lines
2028
to
+2033
| // ゾーン名. | ||
| PrivateHostedZone string `json:"PrivateHostedZone"` | ||
| PrivateHostedZone OptString `json:"PrivateHostedZone"` | ||
| // フォワード先のDNSサーバ(1). | ||
| UpstreamDNS1 string `json:"UpstreamDNS1"` | ||
| UpstreamDNS1 OptString `json:"UpstreamDNS1"` | ||
| // フォワード先のDNSサーバ(2). | ||
| UpstreamDNS2 string `json:"UpstreamDNS2"` | ||
| UpstreamDNS2 OptString `json:"UpstreamDNS2"` |
Member
Author
There was a problem hiding this comment.
This file is auto generated.
Comment on lines
5369
to
5375
| return errors.Wrap(err, "decode field \"Enabled\"") | ||
| } | ||
| case "PrivateHostedZone": | ||
| requiredBitSet[0] |= 1 << 1 | ||
| if err := func() error { | ||
| v, err := d.Str() | ||
| s.PrivateHostedZone = string(v) | ||
| if err != nil { | ||
| s.PrivateHostedZone.Reset() | ||
| if err := s.PrivateHostedZone.Decode(d); err != nil { | ||
| return err |
Member
Author
There was a problem hiding this comment.
That is a legit criticism but the current test structure is not made as such; adding this test is too much of a pull request.
Merged
shyouhei
deleted the
feature/shyouhei/Models.Settings.DNSForwardingSettings/Enabled=False
branch
This file contains hidden or 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
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.
DNSプライベートホストゾーンが無効な場合に、実際のサーバからは
{...,"DNSForwarding":{"Enabled":"False"}}のような短い応答が返ってきうる模様ですので、そういったレスポンスを許容します。