add to api doc

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
Hannah Hunter 2024-06-12 17:02:29 -04:00
parent 49916d8645
commit 712baca84d
1 changed files with 101 additions and 1 deletions

View File

@ -6,4 +6,104 @@ description: "Detailed documentation on the scheduler API"
weight: 1300
---
Need.
{{% alert title="Note" color="primary" %}}
Scheduler is currently in alpha.
{{% /alert %}}
With the Scheduler API, you can orchestrate jobs and tasks in your environment.
## Schedule a job
Schedule a job with the given name.
```
POST http://localhost:3500/v1.0-alpha1/scheduler/job/schedule/<name>
```
### URL parameters
Parameter | Description
--------- | -----------
`name` | Job name
### Request content
Any request content will be passed to the scheduler as input. The Dapr API passes the content as-is without attempting to interpret it.
### HTTP response codes
Code | Description
---- | -----------
`202` | Accepted
`400` | Request was malformed
`500` | Request formatted correctly, error in dapr code or underlying component
### Response content
The API call will provide a response similar to this:
```json
```
## Get job data
Get a job's data with its given name.
```
GET http://localhost:3500/v1.0-alpha1/scheduler/job/<name>
```
### URL parameters
Parameter | Description
--------- | -----------
`name` | Job name
### HTTP response codes
Code | Description
---- | -----------
`202` | Accepted
`400` | Request was malformed
`500` | Request formatted correctly, error in dapr code or underlying component
### Response content
The API call will provide a response similar to this:
```json
```
## Delete a job
Delete a job you've created and scheduled with its given name.
```
DELETE http://localhost:3500/v1.0-alpha1/scheduler/job/<name>
```
### URL parameters
Parameter | Description
--------- | -----------
`name` | Job name
### HTTP response codes
Code | Description
---- | -----------
`202` | Accepted
`400` | Request was malformed
`500` | Request formatted correctly, error in dapr code or underlying component
### Response content
The API call will provide a response similar to this:
```json
```
## Next steps
[Scheduler API overview]({{< ref scheduler-overview.md >}})