Azure / Azure/azure-rest-api-specs

JobMaxRecurrence.Interval has incorrect description

Open
#3,193 0 comments 0 reactions 0 assignees View on GitHub
Scheduler Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

Copied from https://github.com/Azure/azure-sdk-for-go/issues/1822
The property Interval's description states:
// Interval - Gets or sets the interval between retries.
when it really is the max interval between recurrences. Additionally the property above it: RecurrenceFrequency doesn't state its the max frequency, but this is less wrong.
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/scheduler/resource-manager/Microsoft.Scheduler/stable/2016-03-01/scheduler.json#L1352

Contributor guide

Open the contributing guide

Research direction

Open specification/scheduler/resource-manager/Microsoft.Scheduler/stable/2016-03-01/scheduler.json around line 1352 and inspect JobMaxRecurrence.Interval and RecurrenceFrequency. Update the descriptions to reflect their maximum recurrence interval and frequency, then verify the specification remains valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.