You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "jak78 (via GitHub)" <gi...@apache.org> on 2023/11/10 21:55:43 UTC

[PR] [improve][doc] clarify the expected schema types and definition data on admin API docs [pulsar-site]

jak78 opened a new pull request, #730:
URL: https://github.com/apache/pulsar-site/pull/730

   
   <!--
   
   ### Contribution Checklist
     
     - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. 
   
   -->
   
   <!-- Either this PR adds a doc for a code PR, -->
   
   This PR specifies the allowed values for the `type` and `schema` fields of the schema payload used by the upload admin endpoint.
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   - [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `./preview.sh` at root path) to your PR description, or else your PR might not get merged. -->
   - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
   - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
   - [ ] `doc-complete` <!-- Docs have been already added -->
   


-- 
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


Re: [PR] [improve][doc] clarify the usage of the schema admin API [pulsar-site]

Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun merged PR #730:
URL: https://github.com/apache/pulsar-site/pull/730


-- 
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


Re: [PR] [improve][doc] clarify the expected schema types and definition data on admin API docs [pulsar-site]

Posted by "jak78 (via GitHub)" <gi...@apache.org>.
jak78 commented on PR #730:
URL: https://github.com/apache/pulsar-site/pull/730#issuecomment-1807804983

   Thank you @tisonkun for this good catch! The doc is indeed wrong. I'm going to double-check the REST & Java part and push a fix.


-- 
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


Re: [PR] [improve][doc] clarify the expected schema types and definition data on admin API docs [pulsar-site]

Posted by "jak78 (via GitHub)" <gi...@apache.org>.
jak78 commented on PR #730:
URL: https://github.com/apache/pulsar-site/pull/730#issuecomment-1807951677

   The intent of `@inject` is to generate a link to the reference API doc. `inject` presents the link as a URL. This is misleading because the URL displayed by `inject` is not the endpoint URL. In my opinion, this is a bug or an improvement opportunity for `inject`. So I suggest letting the `inject` as-is, waiting for the `inject` bug to be fixed. 
   
   To clarify things to the users trying to upload a schema using the REST API, I provided an example usage with `curl` in the following commit: https://github.com/apache/pulsar-site/pull/730/commits/490a9d2fb77ecb83b731db76d4e7230227390671
   ![Screenshot 2023-11-13 at 12 08 50 PM](https://github.com/apache/pulsar-site/assets/351773/2804dce4-4b47-4852-836e-b8d178fc6795)
   


-- 
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