Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(swagger): regenerate specification files #160

Merged
merged 1 commit into from
Apr 17, 2024
Merged

docs(swagger): regenerate specification files #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1354,8 +1354,13 @@
"description": "If not nil, set the scheduled time of the task to the specified value."
},
"state": {
"type": "integer",
"description": "If not nil, set the state of the task to the specified value.\nIf nil, the state of the task will be set to \"completed\" by default."
"type": "object",
"description": "If not nil, set the state of the task to the specified value.\nIf nil, the state of the task will be set to \"completed\" by default.",
"allOf": [
{
"$ref": "#/components/schemas/ratus.TaskState"
}
]
},
"topic": {
"type": "string",
Expand Down Expand Up @@ -1467,15 +1472,35 @@
"description": "The time the task is scheduled to be executed. Tasks will not be\nexecuted until the scheduled time arrives. After the scheduled time,\nexcessive tasks will be executed in the order of the scheduled time."
},
"state": {
"type": "integer",
"description": "Current state of the task. At a given moment, the state of a task may be\neither \"pending\", \"active\", \"completed\" or \"archived\"."
"type": "object",
"description": "Current state of the task. At a given moment, the state of a task may be\neither \"pending\", \"active\", \"completed\" or \"archived\".",
"allOf": [
{
"$ref": "#/components/schemas/ratus.TaskState"
}
]
},
"topic": {
"type": "string",
"description": "Topic that the task currently belongs to. Tasks under the same topic\nwill be executed according to the scheduled time."
}
}
},
"ratus.TaskState": {
"type": "integer",
"enum": [
0,
1,
2,
3
],
"x-enum-varnames": [
"TaskStatePending",
"TaskStateActive",
"TaskStateCompleted",
"TaskStateArchived"
]
},
"ratus.Tasks": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1525,5 +1550,6 @@
}
}
}
}
},
"x-original-swagger-version": "2.0"
}
Loading