Skip to content

Commit 5369d1f

Browse files
Jamie Tannajamietanna
authored andcommitted
chore(examples): add a deprecated field without any reason
In the case that we have a field deprecated, but no reason, the deprecation comment isn't ideal. Let's document it now, and improve it afterwards.
1 parent f6889c0 commit 5369d1f

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

examples/extensions/xdeprecatedreason/api.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,7 @@ components:
2626
type: number
2727
# NOTE that this doesn't generate, as no `deprecated: true` is set
2828
x-deprecated-reason: NOTE you shouldn't see this, as you've not deprecated this field
29+
deprecated_without_reason:
30+
type: string
31+
deprecated: true
32+
# no `x-deprecated-reason` is set

examples/extensions/xdeprecatedreason/gen.go

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)