You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/07/08 07:41:13 UTC

[GitHub] [pulsar] shibd opened a new pull request, #16470: [improve][rest] Add lookup REST Api swagger docs describe

shibd opened a new pull request, #16470:
URL: https://github.com/apache/pulsar/pull/16470

   ### Motivation
   
   Current, Lookup REST Api no swagger docs annotations. will result in not being found on [Pulsar REST Api doc](https://pulsar.apache.org/admin-rest-api/?version=master).
   
   ### Modifications
   
   - Add lookup REST Api swagger docs describe
   
   ### Documentation
   
   - [x] `doc-not-needed` 
   Docs has exist.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] Anonymitaet commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1181624455

   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] momo-jun commented on a diff in pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#discussion_r917521511


##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -45,6 +49,10 @@ public class TopicLookup extends TopicLookupBase {
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Look up a topic from the current serving broker.",

Review Comment:
   This doc page is deprecated and no longer maintained.
   You can find the related information on [this page](https://pulsar.apache.org/docs/next/admin-api-topics/#lookup-of-topic).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on a diff in pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on code in PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#discussion_r917514129


##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -45,6 +49,10 @@ public class TopicLookup extends TopicLookupBase {
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Look up a topic from the current serving broker.",

Review Comment:
   Agree,  Maybe also need to change it?
   
   https://github.com/apache/pulsar/blob/81841eba724e41d243ba7afc58fcc7634513938b/site2/docs/reference-pulsar-admin.md?plain=1#L2653-L2654



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on a diff in pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on code in PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#discussion_r917514346


##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -72,6 +80,10 @@ public void lookupTopicAsync(
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}/bundle")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Get the namespace bundle which contains the given topic.",

Review Comment:
   Agree, Maybe also need to change it?
   
   https://github.com/apache/pulsar/blob/81841eba724e41d243ba7afc58fcc7634513938b/site2/docs/reference-pulsar-admin.md?plain=1#L2664-L2665



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1180262848

   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1179854328

   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1179847383

   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] codelipenghui commented on a diff in pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on code in PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#discussion_r917485990


##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -72,6 +80,10 @@ public void lookupTopicAsync(
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}/bundle")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Get the namespace bundle which contains the given topic.",

Review Comment:
   ```suggestion
               value = "Get the namespace bundle which the given topic belongs to.",
   ```



##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -45,6 +49,10 @@ public class TopicLookup extends TopicLookupBase {
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Look up a topic from the current serving broker.",

Review Comment:
   Should it be `Get the owner broker of the given topic`?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] Anonymitaet commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1179865435

   @urfreespace 
   could you please review this PR from the technical perspective? Thank you!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] shibd commented on pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
shibd commented on PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#issuecomment-1179108160

   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] momo-jun commented on a diff in pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #16470:
URL: https://github.com/apache/pulsar/pull/16470#discussion_r917522142


##########
pulsar-broker/src/main/java/org/apache/pulsar/broker/lookup/v2/TopicLookup.java:
##########
@@ -72,6 +80,10 @@ public void lookupTopicAsync(
     @GET
     @Path("{topic-domain}/{tenant}/{namespace}/{topic}/bundle")
     @Produces(MediaType.APPLICATION_JSON)
+    @ApiOperation(
+            value = "Get the namespace bundle which contains the given topic.",

Review Comment:
   This doc page is deprecated and no longer maintained.
   You can find the related information on [this page](https://pulsar.apache.org/docs/next/admin-api-topics/#get-bundle).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] codelipenghui merged pull request #16470: [improve][rest] Add lookup REST Api swagger docs describe

Posted by GitBox <gi...@apache.org>.
codelipenghui merged PR #16470:
URL: https://github.com/apache/pulsar/pull/16470


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org