Skip to content

Commit d7baf1d

Browse files
korawicakorawica
committed
📄 docs: update readme file.
1 parent 45cd2ed commit d7baf1d

3 files changed

Lines changed: 79 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,6 @@ For comprehensive API documentation, examples, and best practices:
105105
- **[Full Documentation](https://ddeutils.github.io/ddeutil-workflow/)** - Complete user guide and API reference
106106
- **[Getting Started](https://ddeutils.github.io/ddeutil-workflow/getting-started/)** - Quick start guide
107107
- **[API Reference](https://ddeutils.github.io/ddeutil-workflow/api/workflow/)** - Detailed API documentation
108-
- **[Examples](https://ddeutils.github.io/ddeutil-workflow/examples/)** - Real-world usage examples
109108

110109
## 🎯 Usage
111110

‎docs/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ the base deps.
8787
If you want to install this package with application add-ons, you should add
8888
`app` in installation;
8989

90-
| Use-case | Install Optional | Support |
91-
|----------------|------------------------------------------|:-------------------:|
92-
| Python | `pip install ddeutil-workflow` | :heavy_check_mark: |
93-
| FastAPI Server | `pip install ddeutil-workflow[api]` | :heavy_check_mark: |
90+
| Use-case | Install Optional | Support |
91+
|----------------|-------------------------|:-------:|
92+
| Python | `ddeutil-workflow` | ✅ |
93+
| FastAPI Server | `ddeutil-workflow[all]` | ✅ |
9494

9595
## 🎯 Usage
9696

‎json-schema.json‎

Lines changed: 75 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"title": "Workflow Configuration Schema",
3+
"title": "Workflow Configuration JSON Schema",
44
"version": "0.0.77",
55
"$defs": {
66
"ArrayParam": {
@@ -86,6 +86,9 @@
8686
{
8787
"type": "string"
8888
},
89+
{
90+
"type": "boolean"
91+
},
8992
{
9093
"type": "null"
9194
}
@@ -168,6 +171,9 @@
168171
{
169172
"type": "string"
170173
},
174+
{
175+
"type": "boolean"
176+
},
171177
{
172178
"type": "null"
173179
}
@@ -248,6 +254,9 @@
248254
{
249255
"type": "string"
250256
},
257+
{
258+
"type": "boolean"
259+
},
251260
{
252261
"type": "null"
253262
}
@@ -356,7 +365,7 @@
356365
},
357366
"timezone": {
358367
"default": "UTC",
359-
"description": "A timezone string value.",
368+
"description": "A timezone string value that will pass to ZoneInfo.",
360369
"enum": [
361370
"Africa/Abidjan",
362371
"Africa/Accra",
@@ -974,7 +983,7 @@
974983
"type": "object"
975984
},
976985
"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.",
986+
"description": "Crontab model using interval-based specification.\n\nAttributes:\n interval: (Interval)\n A scheduling interval string ('daily', 'weekly', 'monthly').\n day: (str, default None)\n Day specification for weekly/monthly schedules.\n time: Time of day in 'HH:MM' format.",
978987
"properties": {
979988
"extras": {
980989
"additionalProperties": true,
@@ -984,7 +993,7 @@
984993
},
985994
"timezone": {
986995
"default": "UTC",
987-
"description": "A timezone string value.",
996+
"description": "A timezone string value that will pass to ZoneInfo.",
988997
"enum": [
989998
"Africa/Abidjan",
990999
"Africa/Accra",
@@ -1590,6 +1599,7 @@
15901599
"type": "string"
15911600
},
15921601
"interval": {
1602+
"description": "A scheduling interval string.",
15931603
"enum": [
15941604
"daily",
15951605
"weekly",
@@ -1612,6 +1622,8 @@
16121622
},
16131623
"time": {
16141624
"default": "00:00",
1625+
"description": "A time of day that pass with format 'HH:MM'.",
1626+
"pattern": "\\d{2}:\\d{2}",
16151627
"title": "Time",
16161628
"type": "string"
16171629
}
@@ -1633,7 +1645,7 @@
16331645
},
16341646
"timezone": {
16351647
"default": "UTC",
1636-
"description": "A timezone string value.",
1648+
"description": "A timezone string value that will pass to ZoneInfo.",
16371649
"enum": [
16381650
"Africa/Abidjan",
16391651
"Africa/Accra",
@@ -2437,6 +2449,9 @@
24372449
{
24382450
"type": "string"
24392451
},
2452+
{
2453+
"type": "boolean"
2454+
},
24402455
{
24412456
"type": "null"
24422457
}
@@ -2527,6 +2542,9 @@
25272542
{
25282543
"type": "string"
25292544
},
2545+
{
2546+
"type": "boolean"
2547+
},
25302548
{
25312549
"type": "null"
25322550
}
@@ -2690,6 +2708,9 @@
26902708
{
26912709
"type": "string"
26922710
},
2711+
{
2712+
"type": "boolean"
2713+
},
26932714
{
26942715
"type": "null"
26952716
}
@@ -2722,6 +2743,10 @@
27222743
},
27232744
{
27242745
"type": "string"
2746+
},
2747+
{
2748+
"additionalProperties": true,
2749+
"type": "object"
27252750
}
27262751
],
27272752
"description": "A items for passing to stages via ${{ item }} template parameter.",
@@ -3079,10 +3104,8 @@
30793104
"description": "Runs-on Docker container.",
30803105
"properties": {
30813106
"type": {
3082-
"const": "docker",
3083-
"default": "docker",
3084-
"title": "Type",
3085-
"type": "string"
3107+
"$ref": "#/$defs/RunsOn",
3108+
"default": "docker"
30863109
},
30873110
"with": {
30883111
"$ref": "#/$defs/DockerArgs"
@@ -3095,10 +3118,8 @@
30953118
"description": "Runs-on local.",
30963119
"properties": {
30973120
"type": {
3098-
"const": "local",
3099-
"default": "local",
3100-
"title": "Type",
3101-
"type": "string"
3121+
"$ref": "#/$defs/RunsOn",
3122+
"default": "local"
31023123
},
31033124
"with": {
31043125
"additionalProperties": true,
@@ -3114,10 +3135,8 @@
31143135
"description": "Runs-on self-hosted.",
31153136
"properties": {
31163137
"type": {
3117-
"const": "self_hosted",
3118-
"default": "self_hosted",
3119-
"title": "Type",
3120-
"type": "string"
3138+
"$ref": "#/$defs/RunsOn",
3139+
"default": "self_hosted"
31213140
},
31223141
"with": {
31233142
"$ref": "#/$defs/SelfHostedArgs"
@@ -3174,6 +3193,9 @@
31743193
{
31753194
"type": "string"
31763195
},
3196+
{
3197+
"type": "boolean"
3198+
},
31773199
{
31783200
"type": "null"
31793201
}
@@ -3300,6 +3322,9 @@
33003322
{
33013323
"type": "string"
33023324
},
3325+
{
3326+
"type": "boolean"
3327+
},
33033328
{
33043329
"type": "null"
33053330
}
@@ -3380,6 +3405,9 @@
33803405
{
33813406
"type": "string"
33823407
},
3408+
{
3409+
"type": "boolean"
3410+
},
33833411
{
33843412
"type": "null"
33853413
}
@@ -3415,6 +3443,19 @@
34153443
"title": "Rule",
34163444
"type": "string"
34173445
},
3446+
"RunsOn": {
3447+
"description": "Runs-On enum object.",
3448+
"enum": [
3449+
"local",
3450+
"self_hosted",
3451+
"azure_batch",
3452+
"aws_batch",
3453+
"cloud_batch",
3454+
"docker"
3455+
],
3456+
"title": "RunsOn",
3457+
"type": "string"
3458+
},
34183459
"SelfHostedArgs": {
34193460
"description": "Self-Hosted arguments.",
34203461
"properties": {
@@ -3604,6 +3645,9 @@
36043645
{
36053646
"type": "string"
36063647
},
3648+
{
3649+
"type": "boolean"
3650+
},
36073651
{
36083652
"type": "null"
36093653
}
@@ -3684,6 +3728,9 @@
36843728
{
36853729
"type": "string"
36863730
},
3731+
{
3732+
"type": "boolean"
3733+
},
36873734
{
36883735
"type": "null"
36893736
}
@@ -3828,6 +3875,9 @@
38283875
{
38293876
"type": "string"
38303877
},
3878+
{
3879+
"type": "boolean"
3880+
},
38313881
{
38323882
"type": "null"
38333883
}
@@ -3986,6 +4036,14 @@
39864036
"title": "Jobs",
39874037
"type": "object"
39884038
},
4039+
"tags": {
4040+
"description": "A list of tag that use for simple grouping workflow.",
4041+
"items": {
4042+
"type": "string"
4043+
},
4044+
"title": "Tags",
4045+
"type": "array"
4046+
},
39894047
"created_at": {
39904048
"description": "A created datetime of this workflow template when loading from file.",
39914049
"format": "date-time",

0 commit comments

Comments
 (0)