Skip to content

Commit 3e50887

Browse files
lhotarilhotari
authored
Fix REST API urls in documentation (#970)
BUILD_ALL_VERSION=1 * Fix loading of ES Modules in CommonJS based docusaurus.config.js - following instructions in https://docusaurus.io/docs/markdown-features/plugins#installing-plugins * Use Typescript based config so that ts remark plugins can be used * Add swagger plugin for handling Admin API links * Patch 4.0.x docs * Patch 3.0.x version docs * Fix sink and source creation api operations * Fix start operations * Move site url config to site-baseurls.js
1 parent 38df993 commit 3e50887

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+1433
-1155
lines changed

‎docs/admin-api-brokers.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ localhost:8080
4545
</TabItem>
4646
<TabItem value="REST API">
4747
48-
{@inject: endpoint|GET|/admin/v2/brokers/:cluster|operation/getActiveBrokers?version=@pulsar:version_number@}
48+
[](swagger:/admin/v2/BrokersBase_getActiveBrokers?summary=in+the+cluster)
4949
5050
</TabItem>
5151
<TabItem value="Java">
@@ -90,7 +90,7 @@ public/default/0x80000000_0xc0000000 [broker_assignment=shared is_controlled=
9090
</TabItem>
9191
<TabItem value="REST API">
9292
93-
{@inject: endpoint|GET|/admin/v2/brokers/:cluster/:broker/ownedNamespaces|operation/getOwnedNamespaes?version=@pulsar:version_number@}
93+
[](swagger:/admin/v2/BrokersBase_getOwnedNamespaces)
9494
9595
</TabItem>
9696
<TabItem value="Java">
@@ -104,7 +104,7 @@ admin.brokers().getOwnedNamespaces(cluster,brokerUrl);
104104
</Tabs>
105105
````
106106

107-
## Update broker conf
107+
## Update broker conf
108108

109109
You can update broker configurations using one of the following ways:
110110

@@ -144,7 +144,7 @@ resourceUsageTransportPublishIntervalInSecs
144144
</TabItem>
145145
<TabItem value="REST API">
146146
147-
{@inject: endpoint|GET|/admin/v2/brokers/configuration|operation/getDynamicConfigurationName?version=@pulsar:version_number@}
147+
[](swagger:/admin/v2/BrokersBase_getDynamicConfigurationName)
148148
149149
</TabItem>
150150
<TabItem value="Java">
@@ -175,7 +175,7 @@ pulsar-admin brokers update-dynamic-config --config brokerShutdownTimeoutMs --va
175175
</TabItem>
176176
<TabItem value="REST API">
177177
178-
{@inject: endpoint|POST|/admin/v2/brokers/configuration/:configName/:configValue|operation/updateDynamicConfiguration?version=@pulsar:version_number@}
178+
[](swagger:/admin/v2/BrokersBase_updateDynamicConfiguration)
179179
180180
</TabItem>
181181
<TabItem value="Java">
@@ -211,7 +211,7 @@ brokerShutdownTimeoutMs 100
211211
</TabItem>
212212
<TabItem value="REST API">
213213
214-
{@inject: endpoint|GET|/admin/v2/brokers/configuration/values|operation/getAllDynamicConfigurations?version=@pulsar:version_number@}
214+
[](swagger:/admin/v2/BrokersBase_getAllDynamicConfigurations)
215215
216216
</TabItem>
217217
<TabItem value="Java">
@@ -250,7 +250,7 @@ Example output:
250250
</TabItem>
251251
<TabItem value="REST API">
252252
253-
{@inject: endpoint|GET|/admin/v2/brokers/leaderBroker|operation/getLeaderBroker?version=@pulsar:version_number@}
253+
[](swagger:/admin/v2/BrokersBase_getLeaderBroker)
254254
255255
</TabItem>
256256
<TabItem value="Java">
@@ -264,4 +264,4 @@ For the detail of the code above, see [here](https://github.com/apache/pulsar/bl
264264
</TabItem>
265265
266266
</Tabs>
267-
````
267+
````

‎docs/admin-api-clusters.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ pulsar-admin clusters create cluster-1 \
5353
</TabItem>
5454
<TabItem value="REST API">
5555
56-
{@inject: endpoint|PUT|/admin/v2/clusters/:cluster|operation/createCluster?version=@pulsar:version_number@}
56+
[](swagger:/admin/v2/ClustersBase_createCluster)
5757
5858
</TabItem>
5959
<TabItem value="Java">
@@ -103,7 +103,7 @@ Output:
103103
</TabItem>
104104
<TabItem value="REST API">
105105
106-
{@inject: endpoint|GET|/admin/v2/clusters/:cluster|operation/getCluster?version=@pulsar:version_number@}
106+
[](swagger:/admin/v2/ClustersBase_getCluster)
107107
108108
</TabItem>
109109
<TabItem value="Java">
@@ -140,7 +140,7 @@ pulsar-admin clusters update cluster-1 \
140140
</TabItem>
141141
<TabItem value="REST API">
142142
143-
{@inject: endpoint|POST|/admin/v2/clusters/:cluster|operation/updateCluster?version=@pulsar:version_number@}
143+
[](swagger:/admin/v2/ClustersBase_updateCluster)
144144
145145
</TabItem>
146146
<TabItem value="Java">
@@ -179,7 +179,7 @@ pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2
179179
</TabItem>
180180
<TabItem value="REST API">
181181
182-
{@inject: endpoint|POST|/admin/v2/clusters/:cluster/peers|operation/setPeerClusterNames?version=@pulsar:version_number@}
182+
[](swagger:/admin/v2/ClustersBase_setPeerClusterNames)
183183
184184
</TabItem>
185185
<TabItem value="Java">
@@ -218,7 +218,7 @@ cluster-2
218218
</TabItem>
219219
<TabItem value="REST API">
220220
221-
{@inject: endpoint|GET|/admin/v2/clusters|operation/getClusters?version=@pulsar:version_number@}
221+
[](swagger:/admin/v2/ClustersBase_getClusters)
222222
223223
</TabItem>
224224
<TabItem value="Java">
@@ -250,7 +250,7 @@ pulsar-admin clusters delete cluster-1
250250
</TabItem>
251251
<TabItem value="REST API">
252252
253-
{@inject: endpoint|DELETE|/admin/v2/clusters/:cluster|operation/deleteCluster?version=@pulsar:version_number@}
253+
[](swagger:/admin/v2/ClustersBase_deleteCluster)
254254
255255
</TabItem>
256256
<TabItem value="Java">

‎docs/admin-api-functions.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ pulsar-admin functions create \
5252
</TabItem>
5353
<TabItem value="REST API">
5454
55-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName|operation/registerFunction?version=@pulsar:version_number@}
55+
[](swagger:/admin/v3/functions/FunctionsBase_registerFunction)
5656
5757
</TabItem>
5858
<TabItem value="Java">
@@ -104,7 +104,7 @@ pulsar-admin functions update \
104104
</TabItem>
105105
<TabItem value="REST API">
106106
107-
{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName|operation/updateFunction?version=@pulsar:version_number@}
107+
[](swagger:/admin/v3/functions/FunctionsBase_updateFunction)
108108
109109
</TabItem>
110110
<TabItem value="Java">
@@ -153,7 +153,7 @@ pulsar-admin functions start \
153153
</TabItem>
154154
<TabItem value="REST API">
155155
156-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start|operation/startFunction?version=@pulsar:version_number@}
156+
[](swagger:/admin/v3/functions/FunctionsBase_startFunction?summary=an+instance)
157157
158158
</TabItem>
159159
<TabItem value="Java">
@@ -191,7 +191,7 @@ pulsar-admin functions start \
191191
</TabItem>
192192
<TabItem value="REST API">
193193
194-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start|operation/startFunction?version=@pulsar:version_number@}
194+
[](swagger:/admin/v3/functions/FunctionsBase_startFunction?summary=all)
195195
196196
</TabItem>
197197
<TabItem value="Java">
@@ -234,7 +234,7 @@ pulsar-admin functions stop \
234234
</TabItem>
235235
<TabItem value="REST API">
236236
237-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop|operation/stopFunction?version=@pulsar:version_number@}
237+
[](swagger:/admin/v3/functions/FunctionsBase_stopFunction?summary=an+instance)
238238
239239
</TabItem>
240240
<TabItem value="Java">
@@ -272,7 +272,7 @@ pulsar-admin functions stop \
272272
</TabItem>
273273
<TabItem value="REST API">
274274
275-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop|operation/stopFunction?version=@pulsar:version_number@}
275+
[](swagger:/admin/v3/functions/FunctionsBase_stopFunction?summary=all)
276276
277277
</TabItem>
278278
<TabItem value="Java">
@@ -315,7 +315,7 @@ pulsar-admin functions restart \
315315
</TabItem>
316316
<TabItem value="REST API">
317317
318-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart|operation/restartFunction?version=@pulsar:version_number@}
318+
[](swagger:/admin/v3/functions/FunctionsBase_restartFunction?summary=an+instance)
319319
320320
</TabItem>
321321
<TabItem value="Java">
@@ -353,7 +353,7 @@ pulsar-admin functions restart \
353353
</TabItem>
354354
<TabItem value="REST API">
355355
356-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart|operation/restartFunction?version=@pulsar:version_number@}
356+
[](swagger:/admin/v3/functions/FunctionsBase_restartFunction?summary=all)
357357
358358
</TabItem>
359359
<TabItem value="Java">
@@ -390,7 +390,7 @@ pulsar-admin functions list \
390390
</TabItem>
391391
<TabItem value="REST API">
392392
393-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace|operation/listFunctions?version=@pulsar:version_number@}
393+
[](swagger:/admin/v3/functions/FunctionsBase_listFunctions)
394394
395395
</TabItem>
396396
<TabItem value="Java">
@@ -428,7 +428,7 @@ pulsar-admin functions delete \
428428
</TabItem>
429429
<TabItem value="REST API">
430430
431-
{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName|operation/deregisterFunction?version=@pulsar:version_number@}
431+
[](swagger:/admin/v3/functions/FunctionsBase_deregisterFunction)
432432
433433
</TabItem>
434434
<TabItem value="Java">
@@ -466,7 +466,7 @@ pulsar-admin functions get \
466466
</TabItem>
467467
<TabItem value="REST API">
468468
469-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName|operation/getFunctionInfo?version=@pulsar:version_number@}
469+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionInfo)
470470
471471
</TabItem>
472472
<TabItem value="Java">
@@ -508,7 +508,7 @@ pulsar-admin functions status \
508508
</TabItem>
509509
<TabItem value="REST API">
510510
511-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status|operation/getFunctionInstanceStatus?version=@pulsar:version_number@}
511+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionInstanceStatus)
512512
513513
</TabItem>
514514
<TabItem value="Java">
@@ -546,7 +546,7 @@ pulsar-admin functions status \
546546
</TabItem>
547547
<TabItem value="REST API">
548548
549-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status|operation/getFunctionStatus?version=@pulsar:version_number@}
549+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionStatus)
550550
551551
</TabItem>
552552
<TabItem value="Java">
@@ -588,7 +588,7 @@ pulsar-admin functions stats \
588588
</TabItem>
589589
<TabItem value="REST API">
590590
591-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats|operation/getFunctionInstanceStats?version=@pulsar:version_number@}
591+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionInstanceStats)
592592
593593
</TabItem>
594594
<TabItem value="Java">
@@ -626,7 +626,7 @@ pulsar-admin functions stats \
626626
</TabItem>
627627
<TabItem value="REST API">
628628
629-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats|operation/getFunctionStats?version=@pulsar:version_number@}
629+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionStats)
630630
631631
</TabItem>
632632
<TabItem value="Java">
@@ -667,7 +667,7 @@ pulsar-admin functions trigger \
667667
</TabItem>
668668
<TabItem value="REST API">
669669
670-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger|operation/triggerFunction?version=@pulsar:version_number@}
670+
[](swagger:/admin/v3/functions/FunctionsBase_triggerFunction)
671671
672672
</TabItem>
673673
<TabItem value="Java">
@@ -708,7 +708,7 @@ pulsar-admin functions putstate \
708708
</TabItem>
709709
<TabItem value="REST API">
710710
711-
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/putFunctionState?version=@pulsar:version_number@}
711+
[](swagger:/admin/v3/functions/FunctionsBase_putFunctionState)
712712
713713
</TabItem>
714714
<TabItem value="Java">
@@ -749,7 +749,7 @@ pulsar-admin functions querystate \
749749
</TabItem>
750750
<TabItem value="REST API">
751751
752-
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/getFunctionState?version=@pulsar:version_number@}
752+
[](swagger:/admin/v3/functions/FunctionsBase_getFunctionState)
753753
754754
</TabItem>
755755
<TabItem value="Java">
@@ -761,4 +761,4 @@ admin.functions().getFunctionState(tenant, namespace, functionName, key);
761761
</TabItem>
762762
763763
</Tabs>
764-
````
764+
````

0 commit comments

Comments
 (0)