Skip to content

Commit 75435e8

Browse files
committed
📄 docs: update docs for json-schema.
1 parent ab7478c commit 75435e8

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

json-schema.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@
346346
"type": "object"
347347
},
348348
"Crontab": {
349-
"description": "Cron event model (Warped the CronJob object by Pydantic model) to keep\ncrontab value and generate CronRunner object from this crontab value.\n\nMethods:\n - generate: is the main use-case of this schedule object.",
349+
"description": "Cron event model wrapping CronJob functionality.\n\nA Pydantic model that encapsulates crontab scheduling functionality with\nvalidation and datetime generation capabilities.\n\nAttributes:\n cronjob: CronJob instance for schedule validation and datetime generation.\n tz: Timezone string value (alias: timezone).",
350350
"properties": {
351351
"extras": {
352352
"additionalProperties": true,
@@ -974,6 +974,7 @@
974974
"type": "object"
975975
},
976976
"CrontabValue": {
977+
"description": "Crontab model using interval-based specification.\n\nAttributes:\n interval: Scheduling interval ('daily', 'weekly', 'monthly').\n day: Day specification for weekly/monthly schedules.\n time: Time of day in 'HH:MM' format.",
977978
"properties": {
978979
"extras": {
979980
"additionalProperties": true,
@@ -1622,7 +1623,7 @@
16221623
"type": "object"
16231624
},
16241625
"CrontabYear": {
1625-
"description": "Cron event with enhance Year Pydantic model for limit year matrix that\nuse by some data schedule tools like AWS Glue.",
1626+
"description": "Cron event model with enhanced year-based scheduling.\n\nExtends the base Crontab model to support year-specific scheduling,\nparticularly useful for tools like AWS Glue.\n\nAttributes:\n cronjob: CronJobYear instance for year-aware schedule validation and generation.",
16261627
"properties": {
16271628
"extras": {
16281629
"additionalProperties": true,
@@ -2579,7 +2580,7 @@
25792580
"$ref": "#/$defs/CrontabValue"
25802581
}
25812582
],
2582-
"description": "An event models."
2583+
"description": "Event model type supporting year-based, standard, and interval-based cron scheduling."
25832584
},
25842585
"title": "Schedule",
25852586
"type": "array"

0 commit comments

Comments
 (0)