Skip to content

feat(x-deprecated-reason): add default deprecation message #2022

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
jamietanna merged 3 commits into from
Jul 15, 2025
Merged

feat(x-deprecated-reason): add default deprecation message #2022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99720aa
chore: rename variable
Jul 15, 2025
f77c48e
chore(examples): add a deprecated field without any reason
Jul 15, 2025
c50a3d6
feat(x-deprecated-reason): add default deprecation message
Jul 15, 2025
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
4 changes: 4 additions & 0 deletions examples/extensions/xdeprecatedreason/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@ components:
type: number
# NOTE that this doesn't generate, as no `deprecated: true` is set
x-deprecated-reason: NOTE you shouldn't see this, as you've not deprecated this field
deprecated_without_reason:
type: string
deprecated: true
# no `x-deprecated-reason` is set
4 changes: 3 additions & 1 deletion examples/extensions/xdeprecatedreason/gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions internal/test/schemas/schemas.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/codegen/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,8 +705,8 @@ func GenFieldsFromProperties(props []Property) []string {
// This comment has to be on its own line for godoc & IDEs to pick up
var deprecationReason string
if extension, ok := p.Extensions[extDeprecationReason]; ok {
if extOmitEmpty, err := extParseDeprecationReason(extension); err == nil {
deprecationReason = extOmitEmpty
if extDeprecationReason, err := extParseDeprecationReason(extension); err == nil {
deprecationReason = extDeprecationReason
}
}

Expand Down
2 changes: 2 additions & 0 deletions pkg/codegen/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,6 +881,8 @@ func DeprecationComment(reason string) string {
content := "Deprecated:" // The colon is required at the end even without reason
if reason != "" {
content += fmt.Sprintf(" %s", reason)
} else {
content += " this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set"
}

return stringToGoCommentWithPrefix(content, "")
Expand Down