Skip to content

Deprecate fields and methods if file is deprecated #6613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johanbrandhorst merged 2 commits into from
Apr 15, 2026
Merged

Deprecate fields and methods if file is deprecated #6613

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bc1064
Deprecate fields and methods if file is deprecated
Apr 14, 2026
d17220e
PR Review
Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions protoc-gen-openapiv2/internal/genopenapi/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,33 @@ func encodeOpenAPI(file *wrapper, format Format) (*descriptor.ResponseFile, erro
}, nil
}

func deprecateFieldsAndMethods(file *descriptor.File) {
if opts := file.GetOptions(); opts != nil && opts.GetDeprecated() {

@johanbrandhorst johanbrandhorst Apr 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we lift this check outside of this function so that it's clearer in the caller what's happening?

for _, msg := range file.Messages {
for _, field := range msg.GetField() {
if field.Options == nil {
field.Options = &descriptorpb.FieldOptions{}
}
field.Options.Deprecated = proto.Bool(true)
}
}
for _, svc := range file.Services {
for _, method := range svc.GetMethod() {
if method.Options == nil {
method.Options = &descriptorpb.MethodOptions{}
}
method.Options.Deprecated = proto.Bool(true)
}
}
}
}

func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.ResponseFile, error) {
var files []*descriptor.ResponseFile
for _, f := range targets {
// Because of how the generator merges definitions, it is simpler to deprecate field and methods here if the file is deprecated
deprecateFieldsAndMethods(f)
}
if g.reg.IsAllowMerge() {
var mergedTarget *descriptor.File
// try to find proto leader
Expand Down
Loading