Skip to content

Commit a6e09ad

Browse files
feat(uptime): Expand helptext for validator (#81191)
1 parent 90ad0a1 commit a6e09ad

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

src/sentry/uptime/endpoints/validators.py

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ class UptimeMonitorValidator(CamelSnakeSerializer):
6969
name = serializers.CharField(
7070
required=True,
7171
max_length=128,
72-
help_text="Name of the uptime monitor",
72+
help_text="Name of the uptime monitor.",
7373
)
7474
owner = ActorField(
7575
required=False,
@@ -80,24 +80,40 @@ class UptimeMonitorValidator(CamelSnakeSerializer):
8080
max_length=64,
8181
required=False,
8282
allow_null=True,
83-
help_text="Name of the environment",
83+
help_text="Name of the environment to create uptime issues in.",
8484
)
8585
url = URLField(required=True, max_length=255)
8686
interval_seconds = serializers.ChoiceField(
87-
required=True, choices=UptimeSubscription.IntervalSeconds.choices
87+
required=True,
88+
choices=UptimeSubscription.IntervalSeconds.choices,
89+
help_text="Time in seconds between uptime checks.",
8890
)
8991
timeout_ms = serializers.IntegerField(
9092
required=True,
9193
min_value=1000,
9294
max_value=30_000,
95+
help_text="The number of milliseconds the request will wait for a response before timing-out.",
9396
)
9497
mode = serializers.IntegerField(required=False)
9598
method = serializers.ChoiceField(
96-
required=False, choices=UptimeSubscription.SupportedHTTPMethods.choices
99+
required=False,
100+
choices=UptimeSubscription.SupportedHTTPMethods.choices,
101+
help_text="The HTTP method used to make the check request.",
102+
)
103+
headers = serializers.JSONField(
104+
required=False,
105+
help_text="Additional headers to send with the check request.",
106+
)
107+
trace_sampling = serializers.BooleanField(
108+
required=False,
109+
default=False,
110+
help_text="When enabled allows check requets to be considered for dowstream performance tracing.",
111+
)
112+
body = serializers.CharField(
113+
required=False,
114+
allow_null=True,
115+
help_text="The body to send with the check request.",
97116
)
98-
headers = serializers.JSONField(required=False)
99-
trace_sampling = serializers.BooleanField(required=False, default=False)
100-
body = serializers.CharField(required=False, allow_null=True)
101117

102118
def validate(self, attrs):
103119
headers = []

0 commit comments

Comments
 (0)