From 0ce51723faf04626afb1e95188dc3dc49fdb08e0 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Tue, 28 May 2024 15:34:46 -0400 Subject: [PATCH] alpha api doc and create reference api Signed-off-by: Hannah Hunter --- daprdocs/content/en/concepts/building-blocks-concept.md | 3 ++- .../content/en/operations/support/alpha-beta-apis.md | 1 + daprdocs/content/en/reference/api/scheduler_api.md | 9 +++++++++ 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 daprdocs/content/en/reference/api/scheduler_api.md diff --git a/daprdocs/content/en/concepts/building-blocks-concept.md b/daprdocs/content/en/concepts/building-blocks-concept.md index 1841dd584..4f170edc1 100644 --- a/daprdocs/content/en/concepts/building-blocks-concept.md +++ b/daprdocs/content/en/concepts/building-blocks-concept.md @@ -29,4 +29,5 @@ Dapr provides the following building blocks: | [**Configuration**]({{< ref "configuration-api-overview.md" >}}) | `/v1.0/configuration` | The Configuration API enables you to retrieve and subscribe to application configuration items for supported configuration stores. This enables an application to retrieve specific configuration information, for example, at start up or when configuration changes are made in the store. | [**Distributed lock**]({{< ref "distributed-lock-api-overview.md" >}}) | `/v1.0-alpha1/lock` | The distributed lock API enables you to take a lock on a resource so that multiple instances of an application can access the resource without conflicts and provide consistency guarantees. | [**Workflows**]({{< ref "workflow-overview.md" >}}) | `/v1.0-beta1/workflow` | The Workflow API enables you to define long running, persistent processes or data flows that span multiple microservices using Dapr workflows or workflow components. The Workflow API can be combined with other Dapr API building blocks. For example, a workflow can call another service with service invocation or retrieve secrets, providing flexibility and portability. -| [**Cryptography**]({{< ref "cryptography-overview.md" >}}) | `/v1.0-alpha1/crypto` | The Cryptography API enables you to perform cryptographic operations, such as encrypting and decrypting messages, without exposing keys to your application. \ No newline at end of file +| [**Cryptography**]({{< ref "cryptography-overview.md" >}}) | `/v1.0-alpha1/crypto` | The Cryptography API enables you to perform cryptographic operations, such as encrypting and decrypting messages, without exposing keys to your application. +| [**Distributed Scheduler**]({{< ref "cryptography-overview.md" >}}) | `/v1.0-alpha1/scheduler` | The Scheduler API enables you to schedule and orchestrate jobs at scale in your distributed environment. \ No newline at end of file diff --git a/daprdocs/content/en/operations/support/alpha-beta-apis.md b/daprdocs/content/en/operations/support/alpha-beta-apis.md index c35d4fc42..ed31231cd 100644 --- a/daprdocs/content/en/operations/support/alpha-beta-apis.md +++ b/daprdocs/content/en/operations/support/alpha-beta-apis.md @@ -15,6 +15,7 @@ description: "List of current alpha and beta APIs" | Bulk Publish | [Bulk publish proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L59) | `v1.0-alpha1/publish/bulk` | The bulk publish API allows you to publish multiple messages to a topic in a single request. | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | | Bulk Subscribe | [Bulk subscribe proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/appcallback.proto#L57) | N/A | The bulk subscribe application callback receives multiple messages from a topic in a single call. | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | | Cryptography | [Crypto proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L118) | `v1.0-alpha1/crypto` | The cryptography API enables you to perform **high level** cryptography operations for encrypting and decrypting messages. | [Cryptography API]({{< ref "cryptography-overview.md" >}}) | v1.11 | +| Distributed Scheduler | [Scheduler proto](todo) | `v1.0-alpha1/scheduler` | The distributed scheduler API enables you to schedule and orchestrate jobs in your environment. | [Distributed Scheduler API]({{< ref "distributed-scheduler-overview.md" >}}) | v1.14 | ## Beta APIs diff --git a/daprdocs/content/en/reference/api/scheduler_api.md b/daprdocs/content/en/reference/api/scheduler_api.md new file mode 100644 index 000000000..370461491 --- /dev/null +++ b/daprdocs/content/en/reference/api/scheduler_api.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Distributed Scheduler API reference" +linkTitle: "Distributed Scheduler API" +description: "Detailed documentation on the distributed scheduler API" +weight: 1300 +--- + +Need. \ No newline at end of file