diff --git a/docs/admin-api-brokers.md b/docs/admin-api-brokers.md index 65114086fa7d..a322b32c6359 100644 --- a/docs/admin-api-brokers.md +++ b/docs/admin-api-brokers.md @@ -45,7 +45,7 @@ localhost:8080 -{@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@} @@ -90,7 +90,7 @@ public/default/0x80000000_0xc0000000 [broker_assignment=shared is_controlled= -{@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@} @@ -104,7 +104,7 @@ admin.brokers().getOwnedNamespaces(cluster,brokerUrl); ```` -## Update broker conf +## Update broker conf You can update broker configurations using one of the following ways: @@ -144,7 +144,7 @@ resourceUsageTransportPublishIntervalInSecs -{@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@} @@ -175,7 +175,7 @@ pulsar-admin brokers update-dynamic-config --config brokerShutdownTimeoutMs --va -{@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@} @@ -211,7 +211,7 @@ brokerShutdownTimeoutMs 100 -{@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@} @@ -250,7 +250,7 @@ Example output: -{@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@} @@ -264,4 +264,4 @@ For the detail of the code above, see [here](https://github.com/apache/pulsar/bl -```` \ No newline at end of file +```` diff --git a/docs/admin-api-clusters.md b/docs/admin-api-clusters.md index e632d96790c4..f9cf3367fc6c 100644 --- a/docs/admin-api-clusters.md +++ b/docs/admin-api-clusters.md @@ -53,7 +53,7 @@ pulsar-admin clusters create cluster-1 \ -{@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@} @@ -103,7 +103,7 @@ Output: -{@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@} @@ -140,7 +140,7 @@ pulsar-admin clusters update cluster-1 \ -{@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@} @@ -179,7 +179,7 @@ pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2 -{@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@} @@ -218,7 +218,7 @@ cluster-2 -{@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@} @@ -250,7 +250,7 @@ pulsar-admin clusters delete cluster-1 -{@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@} diff --git a/docs/admin-api-functions.md b/docs/admin-api-functions.md index 95189c0f4995..f60040adee74 100644 --- a/docs/admin-api-functions.md +++ b/docs/admin-api-functions.md @@ -52,7 +52,7 @@ pulsar-admin functions create \ -{@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@} @@ -104,7 +104,7 @@ pulsar-admin functions update \ -{@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@} @@ -153,7 +153,7 @@ pulsar-admin functions start \ -{@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@} @@ -191,7 +191,7 @@ pulsar-admin functions start \ -{@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@} @@ -234,7 +234,7 @@ pulsar-admin functions stop \ -{@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@} @@ -272,7 +272,7 @@ pulsar-admin functions stop \ -{@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@} @@ -315,7 +315,7 @@ pulsar-admin functions restart \ -{@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@} @@ -353,7 +353,7 @@ pulsar-admin functions restart \ -{@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@} @@ -390,7 +390,7 @@ pulsar-admin functions list \ -{@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@} @@ -428,7 +428,7 @@ pulsar-admin functions delete \ -{@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@} @@ -466,7 +466,7 @@ pulsar-admin functions get \ -{@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@} @@ -508,7 +508,7 @@ pulsar-admin functions status \ -{@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@} @@ -546,7 +546,7 @@ pulsar-admin functions status \ -{@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@} @@ -588,7 +588,7 @@ pulsar-admin functions stats \ -{@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@} @@ -626,7 +626,7 @@ pulsar-admin functions stats \ -{@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@} @@ -667,7 +667,7 @@ pulsar-admin functions trigger \ -{@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@} @@ -708,7 +708,7 @@ pulsar-admin functions putstate \ -{@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@} @@ -749,7 +749,7 @@ pulsar-admin functions querystate \ -{@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@} @@ -761,4 +761,4 @@ admin.functions().getFunctionState(tenant, namespace, functionName, key); -```` \ No newline at end of file +```` diff --git a/docs/admin-api-namespaces.md b/docs/admin-api-namespaces.md index 6624f9d95c89..f943e0a301a3 100644 --- a/docs/admin-api-namespaces.md +++ b/docs/admin-api-namespaces.md @@ -52,7 +52,7 @@ pulsar-admin namespaces create test-tenant/test-namespace -{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace|operation/createNamespace?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace|operation/Namespaces_createNamespace?version=@pulsar:version_number@} @@ -111,7 +111,7 @@ Example output: -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace|operation/getPolicies?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace|operation/Namespaces_getPolicies?version=@pulsar:version_number@} @@ -151,7 +151,7 @@ test-tenant/namespace2 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant|operation/getTenantNamespaces?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant|operation/Namespaces_getTenantNamespaces?version=@pulsar:version_number@} @@ -184,7 +184,7 @@ pulsar-admin namespaces delete test-tenant/namespace1 -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace|operation/deleteNamespace?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace|operation/Namespaces_deleteNamespace?version=@pulsar:version_number@} @@ -217,7 +217,7 @@ pulsar-admin namespaces set-clusters test-tenant/namespace1 --clusters cl1 -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replication|operation/setNamespaceReplicationClusters?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replication|operation/Namespaces_setNamespaceReplicationClusters?version=@pulsar:version_number@} @@ -254,7 +254,7 @@ cluster2 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replication|operation/getNamespaceReplicationClusters?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replication|operation/Namespaces_getNamespaceReplicationClusters?version=@pulsar:version_number@} @@ -298,7 +298,7 @@ pulsar-admin namespaces set-backlog-quota --limit 10G \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/setBacklogQuota?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/Namespaces_setBacklogQuota?version=@pulsar:version_number@} @@ -335,7 +335,7 @@ destination_storage BacklogQuotaImpl(limit=10737418240, limitSize=10737418240 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap|operation/getBacklogQuotaMap?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap|operation/Namespaces_getBacklogQuotaMap?version=@pulsar:version_number@} @@ -366,7 +366,7 @@ pulsar-admin namespaces remove-backlog-quota test-tenant/namespace1 -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/removeBacklogQuota?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/Namespaces_removeBacklogQuota?version=@pulsar:version_number@} @@ -410,7 +410,7 @@ pulsar-admin namespaces set-persistence \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/setPersistence?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/Namespaces_setPersistence?version=@pulsar:version_number@} @@ -452,7 +452,7 @@ Example output: -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/getPersistence?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/Namespaces_getPersistence?version=@pulsar:version_number@} @@ -487,7 +487,7 @@ pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff --destinationBroke -{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/unload|operation/unloadNamespaceBundle?version=@pulsar:version_number@&destinationBroker=broker1.use.org.com:8080} +{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/unload|operation/Namespaces_unloadNamespaceBundle?version=@pulsar:version_number@&destinationBroker=broker1.use.org.com:8080} @@ -518,7 +518,7 @@ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-tenant/ -{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/split|operation/splitNamespaceBundle?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/split|operation/Namespaces_splitNamespaceBundle?version=@pulsar:version_number@} @@ -551,7 +551,7 @@ pulsar-admin namespaces set-message-ttl --messageTTL 100 test-tenant/namespace1 -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/setNamespaceMessageTTL?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/Namespaces_setNamespaceMessageTTL?version=@pulsar:version_number@} @@ -587,7 +587,7 @@ Example output: -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/getNamespaceMessageTTL?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/Namespaces_getNamespaceMessageTTL?version=@pulsar:version_number@} @@ -622,7 +622,7 @@ pulsar-admin namespaces remove-message-ttl test-tenant/namespace1 -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/removeNamespaceMessageTTL?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/Namespaces_removeNamespaceMessageTTL?version=@pulsar:version_number@} @@ -656,7 +656,7 @@ pulsar-admin namespaces clear-backlog --sub my-subscription test-tenant/namespac -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/clearBacklog|operation/clearNamespaceBacklogForSubscription?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/clearBacklog|operation/Namespaces_clearNamespaceBacklogForSubscription?version=@pulsar:version_number@} @@ -690,7 +690,7 @@ pulsar-admin namespaces clear-backlog \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/:bundle/clearBacklog|operation/clearNamespaceBundleBacklogForSubscription?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/:bundle/clearBacklog|operation/Namespaces_clearNamespaceBundleBacklogForSubscription?version=@pulsar:version_number@} @@ -725,7 +725,7 @@ pulsar-admin namespaces set-retention --size 100M --time 10m test-tenant/namespa -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/retention|operation/setRetention?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/retention|operation/Namespaces_setRetention?version=@pulsar:version_number@} @@ -763,7 +763,7 @@ pulsar-admin namespaces get-retention test-tenant/namespace1 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/retention|operation/getRetention?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/retention|operation/Namespaces_getRetention?version=@pulsar:version_number@} @@ -808,7 +808,7 @@ pulsar-admin namespaces set-dispatch-rate test-tenant/namespace1 \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/setDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/Namespaces_setDispatchRate?version=@pulsar:version_number@} @@ -850,7 +850,7 @@ Example output: -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/getDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/Namespaces_getDispatchRate?version=@pulsar:version_number@} @@ -887,7 +887,7 @@ pulsar-admin namespaces set-subscription-dispatch-rate test-tenant/namespace1 \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/setSubscriptionDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/Namespaces_setSubscriptionDispatchRate?version=@pulsar:version_number@} @@ -929,7 +929,7 @@ Example output: -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/getSubscriptionDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/Namespaces_getSubscriptionDispatchRate?version=@pulsar:version_number@} @@ -965,7 +965,7 @@ pulsar-admin namespaces set-replicator-dispatch-rate test-tenant/namespace1 \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/setDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/Namespaces_setDispatchRate?version=@pulsar:version_number@} @@ -1004,7 +1004,7 @@ pulsar-admin namespaces get-replicator-dispatch-rate test-tenant/namespace1 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/getDispatchRate?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/Namespaces_getDispatchRate?version=@pulsar:version_number@} @@ -1037,7 +1037,7 @@ pulsar-admin namespaces get-deduplication-snapshot-interval test-tenant/namespac -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/getDeduplicationSnapshotInterval?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/Namespaces_getDeduplicationSnapshotInterval?version=@pulsar:version_number@} @@ -1068,7 +1068,7 @@ pulsar-admin namespaces set-deduplication-snapshot-interval test-tenant/namespac -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/setDeduplicationSnapshotInterval?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/Namespaces_setDeduplicationSnapshotInterval?version=@pulsar:version_number@} @@ -1099,7 +1099,7 @@ pulsar-admin namespaces remove-deduplication-snapshot-interval test-tenant/names -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/deleteDeduplicationSnapshotInterval?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval|operation/Namespaces_deleteDeduplicationSnapshotInterval?version=@pulsar:version_number@} @@ -1138,7 +1138,7 @@ pulsar-admin namespaces unload my-tenant/my-ns -{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/unload|operation/unloadNamespace?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/unload|operation/Namespaces_unloadNamespace?version=@pulsar:version_number@} @@ -1174,7 +1174,7 @@ pulsar-admin namespaces set-entry-filters \ -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/setEntryFilters? +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/Namespaces_setEntryFilters? version=@pulsar:version_number@} @@ -1206,7 +1206,7 @@ pulsar-admin namespaces get-entry-filters test-tenant/namespace1 -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/getEntryFilters? +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/Namespaces_getEntryFilters? version=@pulsar:version_number@} @@ -1238,7 +1238,7 @@ pulsar-admin namespaces remove-entry-filters test-tenant/namespace1 -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/removeEntryFilters? +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/entryFilters|operation/Namespaces_removeEntryFilters? version=@pulsar:version_number@} diff --git a/docs/admin-api-packages.md b/docs/admin-api-packages.md index 01bbfffe57cf..d4623648eafa 100644 --- a/docs/admin-api-packages.md +++ b/docs/admin-api-packages.md @@ -103,7 +103,7 @@ bin/pulsar-admin packages upload function://public/default/example@v0.1 --path p -{@inject: endpoint|POST|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/upload?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/Packages_upload?version=@pulsar:version_number@} @@ -142,7 +142,7 @@ bin/pulsar-admin packages download function://public/default/example@v0.1 --path -{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/download?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/Packages_download?version=@pulsar:version_number@} @@ -183,7 +183,7 @@ bin/pulsar-admin packages delete functions://public/default/example@v0.1 -{@inject: endpoint|DELETE|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/delete?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version|operation/Packages_delete?version=@pulsar:version_number@} @@ -222,7 +222,7 @@ bin/pulsar-admin packages get-metadata function://public/default/test@v1 -{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata|operation/getMeta?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata|operation/Packages_getMeta?version=@pulsar:version_number@} @@ -261,7 +261,7 @@ bin/pulsar-admin packages update-metadata function://public/default/example@v0.1 -{@inject: endpoint|PUT|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata|operation/updateMeta?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata|operation/Packages_updateMeta?version=@pulsar:version_number@} @@ -300,7 +300,7 @@ bin/pulsar-admin packages list-versions type://tenant/namespace/packageName -{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName|operation/listPackageVersion?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v3/packages/:type/:tenant/:namespace/:packageName|operation/Packages_listPackageVersion?version=@pulsar:version_number@} @@ -340,7 +340,7 @@ bin/pulsar-admin packages list --type function public/default -{@inject: endpoint|PUT|/admin/v3/packages/:type/:tenant/:namespace|operation/listPackages?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v3/packages/:type/:tenant/:namespace|operation/Packages_listPackages?version=@pulsar:version_number@} diff --git a/docs/admin-api-permissions.md b/docs/admin-api-permissions.md index 5d1eb2e26298..130908f7cf40 100644 --- a/docs/admin-api-permissions.md +++ b/docs/admin-api-permissions.md @@ -89,7 +89,7 @@ Roles `my.1.role`, `my.2.role`, `my.foo.role`, `my.bar.role`, etc. **cannot** pr -{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/permissions/:role|operation/grantPermissionOnNamespace?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/permissions/:role|operation/Namespaces_grantPermissionOnNamespace?version=@pulsar:version_number@} @@ -128,7 +128,7 @@ my.role.* [produce, consume] -{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/permissions|operation/getPermissions?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/permissions|operation/Namespaces_getPermissions?version=@pulsar:version_number@} @@ -162,7 +162,7 @@ pulsar-admin namespaces revoke-permission test-tenant/namespace1 \ -{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/permissions/:role|operation/revokePermissionsOnNamespace?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/permissions/:role|operation/Namespaces_revokePermissionsOnNamespace?version=@pulsar:version_number@} diff --git a/docs/admin-api-tenants.md b/docs/admin-api-tenants.md index 7d61305fb922..029af001286f 100644 --- a/docs/admin-api-tenants.md +++ b/docs/admin-api-tenants.md @@ -56,7 +56,7 @@ my-tenant-2 -{@inject: endpoint|GET|/admin/v2/tenants|operation/getTenants?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/tenants|operation/TenantsBase_getTenants?version=@pulsar:version_number@} @@ -105,7 +105,7 @@ pulsar-admin tenants create my-tenant \ -{@inject: endpoint|PUT|/admin/v2/tenants/:tenant|operation/createTenant?version=@pulsar:version_number@} +{@inject: endpoint|PUT|/admin/v2/tenants/:tenant|operation/TenantsBase_createTenant?version=@pulsar:version_number@} @@ -151,7 +151,7 @@ pulsar-admin tenants get my-tenant -{@inject: endpoint|GET|/admin/v2/tenants/:tenant|operation/getTenant?version=@pulsar:version_number@} +{@inject: endpoint|GET|/admin/v2/tenants/:tenant|operation/TenantsBase_getTenant?version=@pulsar:version_number@} @@ -184,7 +184,7 @@ pulsar-admin tenants delete my-tenant -{@inject: endpoint|DELETE|/admin/v2/tenants/:tenant|operation/deleteTenant?version=@pulsar:version_number@} +{@inject: endpoint|DELETE|/admin/v2/tenants/:tenant|operation/TenantsBase_deleteTenant?version=@pulsar:version_number@} @@ -219,7 +219,7 @@ pulsar-admin tenants update my-tenant \ -{@inject: endpoint|POST|/admin/v2/tenants/:tenant|operation/updateTenant?version=@pulsar:version_number@} +{@inject: endpoint|POST|/admin/v2/tenants/:tenant|operation/TenantsBase_updateTenant?version=@pulsar:version_number@} diff --git a/docs/admin-api-topics.md b/docs/admin-api-topics.md index 2b9e1c6fdba1..4e7230ff0d8b 100644 --- a/docs/admin-api-topics.md +++ b/docs/admin-api-topics.md @@ -41,7 +41,7 @@ Whether it is a persistent or non-persistent topic, you can obtain the topic res :::note In REST API, `:schema` stands for persistent or non-persistent. `:tenant`, `:namespace`, `:x` are variables, replace them with the real tenant, namespace, and `x` names when using them. -Take {@inject: endpoint|GET|/admin/v2/:schema/:tenant/:namespace|operation/getList?version=@pulsar:version_number@} as an example, to get the list of persistent topics in REST API, use `https://pulsar.apache.org/admin/v2/persistent/my-tenant/my-namespace`. To get the list of non-persistent topics in REST API, use `https://pulsar.apache.org/admin/v2/non-persistent/my-tenant/my-namespace`. +Take {@inject: endpoint|GET|/admin/v2/:schema/:tenant/:namespace|operation/PersistentTopics_getList?version=@pulsar:version_number@} as an example, to get the list of persistent topics in REST API, use `https://pulsar.apache.org/admin/v2/persistent/my-tenant/my-namespace`. To get the list of non-persistent topics in REST API, use `https://pulsar.apache.org/admin/v2/non-persistent/my-tenant/my-namespace`. ::: diff --git a/docusaurus.config.js b/docusaurus.config.js index b8d6f18a2502..9fae0ae8b60d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -121,8 +121,22 @@ const injectLinkParseForEndpoint = ([, info]) => { } } + /** + * Removes class name from the REST API docs URL + * /admin/v2//ClassName_methodName => /admin/v2//methodName + * Context: + * - https://github.com/apache/pulsar/issues/21573 + * - https://github.com/apache/pulsar/pull/19193 + */ + function getCurlUrl(path) { + const parts = path.split('/'); + const last = parts[parts.length - 1]; + const [_, methodName] = last.split('_'); + return [...parts.slice(0, parts.length - 1), methodName].join('/'); + } + return { - text: method + " " + path, + text: method + " " + getCurlUrl(path), link: restBaseUrl + "?" + restUrl, }; };