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/10/21 02:25:17 UTC
[GitHub] [pulsar] Jason918 opened a new pull request, #18143: [improve][doc] Update swagger for 2.10.2
Jason918 opened a new pull request, #18143:
URL: https://github.com/apache/pulsar/pull/18143
### Motivation
Update swagger for 2.10.2
### Does this pull request potentially affect one of the following parts:
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) 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 -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed in
a forked repository.
The tests will be run in the forked repository until all PR review comments have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
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] tisonkun commented on pull request #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #18143:
URL: https://github.com/apache/pulsar/pull/18143#issuecomment-1289891880
@michaeljmarshall agree. You may notice #18014 for a similar proposal. I don't read through the logic about swagger files yet. I'll appreciate it if you can share your knowledge about this sync and build process, especially for the API/generated files.
--
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 pull request #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
codelipenghui commented on PR #18143:
URL: https://github.com/apache/pulsar/pull/18143#issuecomment-1288357747
@Anonymitaet Will the swagger files move the `pulsar-site` repo?
--
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] github-actions[bot] commented on pull request #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #18143:
URL: https://github.com/apache/pulsar/pull/18143#issuecomment-1286375167
@Jason918 Please add the following content to your PR description and select a checkbox:
```
- [ ] `doc` <!-- Your PR contains doc changes -->
- [ ] `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
[GitHub] [pulsar] michaeljmarshall merged pull request #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
michaeljmarshall merged PR #18143:
URL: https://github.com/apache/pulsar/pull/18143
--
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] michaeljmarshall commented on pull request #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on PR #18143:
URL: https://github.com/apache/pulsar/pull/18143#issuecomment-1289442518
@Anonymitaet - We need to generate the swagger docs for each released version of Apache Pulsar. In my opinion, it is not sufficient to generate them frequently based on the current state of `branch-2.x` because the swagger docs are used to generate clients, and we want to provide stable versions of these docs.
We should move the swagger files to the pulsar-site repo because they are generated. Note that we already do this in this part of the website's generated doc files here: https://pulsar.apache.org/api/.
--
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 #18143: [improve][doc] Update swagger for 2.10.2
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18143:
URL: https://github.com/apache/pulsar/pull/18143#issuecomment-1288434607
> @Anonymitaet Will the swagger files move the `pulsar-site` repo?
@urfreespace @tisonkun can you take a look at the following questions? Thank you!
### Q1.
Now the swagger files in [pulsar](https://github.com/apache/pulsar/tree/master/site2/website/static/swagger) are synced to [pulsar-site](https://github.com/apache/pulsar-site/tree/main/site2/website-next/static/swagger), can we remove swagger files in pulsar and only keep them in pulsar-site? (Does the REST API doc build process rely on the files in pulsar and must be completed in pulsar?)
### Q2.
We use swagger for generating [REST API docs](https://pulsar.apache.org/admin-rest-api/?version=master) only.
Since we use one doc set now (2.10.x for 2.10.0, 2.10.1, 2.10.2, ...), does this mean we just need to generate REST API doc for 2.10.x only instead of generating for 2.10.0, 2.10.1, 210.2, ...?
If yes, the [release process](https://github.com/apache/pulsar/blob/master/wiki/release/release-process.md#update-swagger-file) needs to be updated (now release managers generate swagger files for each release), that is, swagger files should be only generated for major releases (2.10.x, 2.11.x, 2.12.x, ...) instead of minor releases (2.10.1, 2.10.2, ...).
cc @momo-jun @labuladong
--
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