You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/12/22 18:07:57 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar (#f85d591)
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new cf2b15d317e Docs sync done from apache/pulsar (#f85d591)
cf2b15d317e is described below
commit cf2b15d317eb928cce5858ccb0479379400e1548
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Thu Dec 22 18:07:51 2022 +0000
Docs sync done from apache/pulsar (#f85d591)
---
site2/website-next/docs/admin-api-overview.md | 3 +-
site2/website-next/docs/client-api-overview.md | 18 ++++++++++++
site2/website-next/docs/pulsar-api-overview.md | 33 ++++++++++++++++++++++
site2/website-next/sidebars.json | 14 +++++++++
.../static/assets/admin-api-definition.svg | 1 +
.../static/assets/client-api-definition.svg | 1 +
.../static/assets/pulsar-api-definition.svg | 1 +
.../static/swagger/master/swagger.json | 9 +++---
.../static/swagger/master/v2/swagger.json | 9 +++---
9 files changed, 78 insertions(+), 11 deletions(-)
diff --git a/site2/website-next/docs/admin-api-overview.md b/site2/website-next/docs/admin-api-overview.md
index ae67de958b5..6d8756ff963 100644
--- a/site2/website-next/docs/admin-api-overview.md
+++ b/site2/website-next/docs/admin-api-overview.md
@@ -9,8 +9,9 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
````
+Pulsar admin APIs enable you to administer clusters programmatically. For example, you can create, update, delete, and manage all the entities within Pulsar instances (such as clusters, namespaces, tenants, topics, schemas, connectors, functions, and so on), and set various policies for data, resources, and security.
-The Pulsar admin interface enables you to manage all important entities in a Pulsar instance, such as tenants, topics, and namespaces.
+
You can interact with the admin interface via:
diff --git a/site2/website-next/docs/client-api-overview.md b/site2/website-next/docs/client-api-overview.md
new file mode 100644
index 00000000000..344133e11d2
--- /dev/null
+++ b/site2/website-next/docs/client-api-overview.md
@@ -0,0 +1,18 @@
+---
+id: client-api-overview
+title: Client API
+sidebar_label: "Overview"
+---
+
+````mdx-code-block
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+````
+
+Pulsar client APIs allow you to create and configure producers, consumers, and readers; produce and consume messages; perform authentication and authorization tasks, and so on via programmable interfaces. They encapsulate and optimize Pulsar’s client-broker communication protocols and add additional features using Pulsar primitives. Pulsar exposes client APIs with language bindings for [Java](client-libraries-java.md), [C++](client-libraries-cpp.md), [Python](client-libraries-python.md), [...]
+
+
+
+## Next steps
+
+For more details about Pulsar clients, including language-specific client libraries, feature matrix, third-party clients, see [Pulsar client - Overview](client-libraries.md).
\ No newline at end of file
diff --git a/site2/website-next/docs/pulsar-api-overview.md b/site2/website-next/docs/pulsar-api-overview.md
new file mode 100644
index 00000000000..9b1ecb37c7a
--- /dev/null
+++ b/site2/website-next/docs/pulsar-api-overview.md
@@ -0,0 +1,33 @@
+---
+id: pulsar-api-overview
+title: Pulsar API
+sidebar_label: "Overview"
+---
+
+````mdx-code-block
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+````
+
+Pulsar is a messaging and streaming platform that scales across organizations of all sizes. Pulsar APIs are the core building blocks of Pulsar, which allow you to interact with Pulsar or administer Pulsar clusters. Pulsar APIs consist of the following types:
+
+- [Pulsar client APIs](client-api-overview.md)
+
+- [Pulsar admin APIs](admin-api-overview.md)
+
+
+
+## When to use Pulsar APIs
+
+Pulsar client APIs and Pulsar admin APIs serve two different purposes in the Pulsar API design. You can use Pulsar client APIs to build applications with Pulsar and use Pulsar admin APIs to manage Pulsar clusters.
+
+Here is a simple comparison between Pulsar client APIs and Pulsar admin APIs.
+
+Category|Pulsar client APIs|Pulsar admin APIs
+---|---|---|
+Audiences|Developers|DevOps
+Goals|Build applications with Pulsar|Administer Pulsar clusters
+Use cases|Pulsar client APIs help you create applications that rely on real-time data. <br/><br/> For example, you can build a financial application to handle fraud alerts or an eCommerce application that creates recommendations based on user activities.| Pulsar administration APIs let you administer the entire Pulsar instance, including clusters, tenants, namespaces, and topics, from a single endpoint. <br/><br/> For example, you can configure security and compliance, or get information [...]
+Key features|- Process data with producers, consumers, readers, and TableView <br/><br/> - Secure data with authentication and authorization <br/><br/> - Protect data with transactions and schema <br/><br/> - Stabilize data with cluster-level auto failover | - Configure authentication and authorization <br/><br/> - Set data retention and resource isolation policies <br/><br/> - Facilitate workflow of application development<br/><br/> - Troubleshoot Pulsar
+Interfaces | - [Java client API](client-libraries-java.md) <br/><br/> - [C++ client API](client-libraries-cpp.md) <br/><br/> - [Python client API](client-libraries-python.md) <br/><br/> - [Go client API](client-libraries-go.md) <br/><br/> - [Node.js client API](client-libraries-node.md) <br/><br/> - [WebSocket client API](client-libraries-websocket.md) <br/><br/> - [C# client API](client-libraries-dotnet.md) | - [Java admin API](admin-api-overview.md) <br/><br/> - [REST API](reference-r [...]
+
diff --git a/site2/website-next/sidebars.json b/site2/website-next/sidebars.json
index 97c21a759a6..8cd134c7cfa 100644
--- a/site2/website-next/sidebars.json
+++ b/site2/website-next/sidebars.json
@@ -315,6 +315,20 @@
"client-libraries-rest"
]
},
+ {
+ "type": "category",
+ "label": "Pulsar API",
+ "items": [
+ "pulsar-api-overview"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Client API",
+ "items": [
+ "client-api-overview"
+ ]
+ },
{
"type": "category",
"label": "Admin API",
diff --git a/site2/website-next/static/assets/admin-api-definition.svg b/site2/website-next/static/assets/admin-api-definition.svg
new file mode 100644
index 00000000000..1e067dcb11e
--- /dev/null
+++ b/site2/website-next/static/assets/admin-api-definition.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:lucid="lucid" width="1174.8" height="312.5"><g transform="translate(-38.86163631441559 -37.57446415547713)" lucid:page-tab-id="0_0"><path d="M0 0h6299.2v6299.2H0z" fill="#fff"/><path d="M767.96 63.57a6 6 0 0 1 6-6h307a6 6 0 0 1 6 6v260.5a6 6 0 0 1-6 6h-307a6 6 0 0 1-6-6z" stroke="#4881b3" stroke-width="3" fill="#cfe4ff"/><path d="M807.06 133.02c-8.86 0-16.05-6.36-16.05-14.2 0-6.27 4.36-11.57 11.1-13. [...]
\ No newline at end of file
diff --git a/site2/website-next/static/assets/client-api-definition.svg b/site2/website-next/static/assets/client-api-definition.svg
new file mode 100644
index 00000000000..3908cb95a44
--- /dev/null
+++ b/site2/website-next/static/assets/client-api-definition.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:lucid="lucid" width="1209.54" height="374.95"><g transform="translate(-62.56434173341904 -83.19027391047223)" lucid:page-tab-id="0_0"><path d="M0 0h6299.2v6299.2H0z" fill="#fff"/><path d="M610.8 168l-3.1.47-34.98 6.68-111.47 28.22-45.12 10.68-35.07 6.7-35.33 5.2-39.35 4.12-47.03 2.93-59 1.18-.03-2 58.94-1.18 46.95-2.92 39.28-4.1 35.25-5.2 34.98-6.7 45.07-10.65 111.5-28.24 35.1-6.7 3.43-.5zm159.8-12.6 [...]
\ No newline at end of file
diff --git a/site2/website-next/static/assets/pulsar-api-definition.svg b/site2/website-next/static/assets/pulsar-api-definition.svg
new file mode 100644
index 00000000000..39121cf32da
--- /dev/null
+++ b/site2/website-next/static/assets/pulsar-api-definition.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:lucid="lucid" width="878.63" height="502.93"><g transform="translate(-318.6842944781893 -112.53319647060653)" lucid:page-tab-id="0_0"><path d="M0 0h6299.2v6299.2H0z" fill="#fff"/><path d="M338.68 138.53a6 6 0 0 1 6-6h276.24a6 6 0 0 1 6 6v211.05a6 6 0 0 1-6 6H344.68a6 6 0 0 1-6-6z" stroke="#000" stroke-opacity="0" stroke-width="3" fill="#6db1ff"/><use xlink:href="#a" transform="matrix(1,0,0,1,343.6842 [...]
\ No newline at end of file
diff --git a/site2/website-next/static/swagger/master/swagger.json b/site2/website-next/static/swagger/master/swagger.json
index 5e6933d24a3..2b68a2121be 100644
--- a/site2/website-next/static/swagger/master/swagger.json
+++ b/site2/website-next/static/swagger/master/swagger.json
@@ -28483,9 +28483,6 @@
]
},
"put": {
- "consumes": [
- "application/vnd.partitioned-topic-metadata+json"
- ],
"description": "It needs to be called before creating a producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -28511,12 +28508,14 @@
"type": "string"
},
{
- "description": "The metadata for the topic",
+ "description": "The number of partitions for the topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/PartitionedTopicMetadata"
+ "default": 0,
+ "format": "int32",
+ "type": "integer"
}
},
{
diff --git a/site2/website-next/static/swagger/master/v2/swagger.json b/site2/website-next/static/swagger/master/v2/swagger.json
index 5e6933d24a3..2b68a2121be 100644
--- a/site2/website-next/static/swagger/master/v2/swagger.json
+++ b/site2/website-next/static/swagger/master/v2/swagger.json
@@ -28483,9 +28483,6 @@
]
},
"put": {
- "consumes": [
- "application/vnd.partitioned-topic-metadata+json"
- ],
"description": "It needs to be called before creating a producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -28511,12 +28508,14 @@
"type": "string"
},
{
- "description": "The metadata for the topic",
+ "description": "The number of partitions for the topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/PartitionedTopicMetadata"
+ "default": 0,
+ "format": "int32",
+ "type": "integer"
}
},
{