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 2021/12/28 20:28:12 UTC
[GitHub] [pulsar] addisonj opened a new issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
addisonj opened a new issue #13542:
URL: https://github.com/apache/pulsar/issues/13542
#### Expected behavior
The documentation for the Functions/Connectors APIs (https://pulsar.apache.org/functions-rest-api/?version=2.8.1#operation/registerFunction) should be correct in helping get a user able to upload a function.
This same doc bug also applies for registerSource and registerSink APIs
#### Actual behavior
The docs erroneously indicate that this API accepts a JSON payload. This is incorrect. The API expect a multi-part form, and depending on whether the user is using a builtin function/source/sink, a payload from a url, or uploading locally, the user needs to set different form fields.
It seems like the core of the issue is that the swagger doc being generated does't properly handle multipart annotations and the hand written doc doesn't indicate this either, and focuses only on the JSON blob.
#### Steps to reproduce
Try and follow the docs for uploading a function using curl
#### System configuration
2.9.1 and earlier.
--
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 issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #13542:
URL: https://github.com/apache/pulsar/issues/13542#issuecomment-1002435900
Have talked to @tuteng, we might need to modify both content and format, he will provide an example of that, and then we'll discuss more.
--
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 issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #13542:
URL: https://github.com/apache/pulsar/issues/13542#issuecomment-1007342994
@tuteng will provide a source example later. Will add then.
--
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] tuteng commented on issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
Posted by GitBox <gi...@apache.org>.
tuteng commented on issue #13542:
URL: https://github.com/apache/pulsar/issues/13542#issuecomment-1002571580
--
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 issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #13542:
URL: https://github.com/apache/pulsar/issues/13542#issuecomment-1007342994
@tuteng will provide a source example later. Will add then.
--
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 closed issue #13542: [Doc Bug] - Function/Sources/Sinks API Docs are incorrect
Posted by GitBox <gi...@apache.org>.
Anonymitaet closed issue #13542:
URL: https://github.com/apache/pulsar/issues/13542
--
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