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

Jump to bottom

Use correct REST API URLs in docs #866

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Use correct REST API URLs in docs #866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5d1a71
User the correct curl URLs in docs
visortelle Mar 20, 2024
98f4fac
Updated a few .md files for "next" version
visortelle Mar 20, 2024
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
16 changes: 8 additions & 8 deletions docs/admin-api-brokers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ localhost:8080
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/brokers/:cluster|operation/getActiveBrokers?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/brokers/:cluster|operation/BrokersBase_getActiveBrokers?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -90,7 +90,7 @@ public/default/0x80000000_0xc0000000 [broker_assignment=shared is_controlled=
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/brokers/:cluster/:broker/ownedNamespaces|operation/getOwnedNamespaes?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/brokers/:cluster/:broker/ownedNamespaces|operation/BrokersBase_getOwnedNamespaces?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand All @@ -104,7 +104,7 @@ admin.brokers().getOwnedNamespaces(cluster,brokerUrl);
</Tabs>
````

## Update broker conf
## Update broker conf

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

Expand Down Expand Up @@ -144,7 +144,7 @@ resourceUsageTransportPublishIntervalInSecs
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/brokers/configuration|operation/getDynamicConfigurationName?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/brokers/configuration|operation/BrokersBase_getDynamicConfigurationName?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -175,7 +175,7 @@ pulsar-admin brokers update-dynamic-config --config brokerShutdownTimeoutMs --va
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v2/brokers/configuration/:configName/:configValue|operation/updateDynamicConfiguration?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v2/brokers/configuration/:configName/:configValue|operation/BrokersBase_updateDynamicConfiguration?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -211,7 +211,7 @@ brokerShutdownTimeoutMs 100
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/brokers/configuration/values|operation/getAllDynamicConfigurations?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/brokers/configuration/values|operation/BrokersBase_getAllDynamicConfigurations?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -250,7 +250,7 @@ Example output:
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/brokers/leaderBroker|operation/getLeaderBroker?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/brokers/leaderBroker|operation/BrokersBase_getLeaderBroker?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand All @@ -264,4 +264,4 @@ For the detail of the code above, see [here](https://github.com/apache/pulsar/bl
</TabItem>

</Tabs>
````
````
12 changes: 6 additions & 6 deletions docs/admin-api-clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ pulsar-admin clusters create cluster-1 \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|PUT|/admin/v2/clusters/:cluster|operation/createCluster?version=@pulsar:version_number@}
{@inject: endpoint|PUT|/admin/v2/clusters/:cluster|operation/ClustersBase_createCluster?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -103,7 +103,7 @@ Output:
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/clusters/:cluster|operation/getCluster?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/clusters/:cluster|operation/ClustersBase_getCluster?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -140,7 +140,7 @@ pulsar-admin clusters update cluster-1 \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v2/clusters/:cluster|operation/updateCluster?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v2/clusters/:cluster|operation/ClustersBase_updateCluster?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -179,7 +179,7 @@ pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v2/clusters/:cluster/peers|operation/setPeerClusterNames?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v2/clusters/:cluster/peers|operation/ClustersBase_setPeerClusterNames?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -218,7 +218,7 @@ cluster-2
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v2/clusters|operation/getClusters?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v2/clusters|operation/ClustersBase_getClusters?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -250,7 +250,7 @@ pulsar-admin clusters delete cluster-1
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|DELETE|/admin/v2/clusters/:cluster|operation/deleteCluster?version=@pulsar:version_number@}
{@inject: endpoint|DELETE|/admin/v2/clusters/:cluster|operation/ClustersBase_deleteCluster?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down
38 changes: 19 additions & 19 deletions docs/admin-api-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ pulsar-admin functions create \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName|operation/registerFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName|operation/FunctionsBase_registerFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -104,7 +104,7 @@ pulsar-admin functions update \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName|operation/updateFunction?version=@pulsar:version_number@}
{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName|operation/FunctionsBase_updateFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -153,7 +153,7 @@ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start|operation/startFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start|operation/FunctionsBase_startFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -191,7 +191,7 @@ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start|operation/startFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start|operation/FunctionsBase_startFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -234,7 +234,7 @@ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop|operation/stopFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop|operation/FunctionsBase_stopFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -272,7 +272,7 @@ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop|operation/stopFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop|operation/FunctionsBase_stopFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -315,7 +315,7 @@ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart|operation/restartFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart|operation/FunctionsBase_restartFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -353,7 +353,7 @@ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart|operation/restartFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart|operation/FunctionsBase_restartFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -390,7 +390,7 @@ pulsar-admin functions list \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace|operation/listFunctions?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace|operation/FunctionsBase_listFunctions?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -428,7 +428,7 @@ pulsar-admin functions delete \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName|operation/deregisterFunction?version=@pulsar:version_number@}
{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName|operation/FunctionsBase_deregisterFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -466,7 +466,7 @@ pulsar-admin functions get \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName|operation/getFunctionInfo?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName|operation/FunctionsBase_getFunctionInfo?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -508,7 +508,7 @@ pulsar-admin functions status \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status|operation/getFunctionInstanceStatus?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status|operation/FunctionsBase_getFunctionInstanceStatus?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -546,7 +546,7 @@ pulsar-admin functions status \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status|operation/getFunctionStatus?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status|operation/FunctionsBase_getFunctionStatus?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -588,7 +588,7 @@ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats|operation/getFunctionInstanceStats?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats|operation/FunctionsBase_getFunctionInstanceStats?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -626,7 +626,7 @@ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats|operation/getFunctionStats?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats|operation/FunctionsBase_getFunctionStats?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -667,7 +667,7 @@ pulsar-admin functions trigger \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger|operation/triggerFunction?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger|operation/FunctionsBase_triggerFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -708,7 +708,7 @@ pulsar-admin functions putstate \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/putFunctionState?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/FunctionsBase_putFunctionState?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -749,7 +749,7 @@ pulsar-admin functions querystate \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/getFunctionState?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/FunctionsBase_getFunctionState?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand All @@ -761,4 +761,4 @@ admin.functions().getFunctionState(tenant, namespace, functionName, key);
</TabItem>

</Tabs>
````
````
Loading
Loading