Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Incorrect swagger specs #20164

Open
1 of 2 tasks
ddieruf opened this issue Apr 21, 2023 · 1 comment
Open
1 of 2 tasks

[Bug] Incorrect swagger specs #20164

ddieruf opened this issue Apr 21, 2023 · 1 comment
Labels
Stale type/bug The PR fixed a bug or issue reported a bug

Comments

@ddieruf
Copy link
Contributor

ddieruf commented Apr 21, 2023

Search before asking

  • I searched in the issues and found nothing similar.

Version

Multiple

Minimal reproduce step

Generate a client using different swagger.json specs from the distribution here: https://pulsar.apache.org/swagger/

What did you expect to see?

Given the version (I tried 2.11.1, 2.10.4, 2.10.0, and master) I expected a consistent client library to be created. The only differences should be new features and changed parameters between versions.

Also I expected the Puslar Admin docs here to match the lastest stable version of Pulsar which is 2.11.1.

What did you see instead?

Instead I saw that the Pulsar Admin rest api docs offers a download from "master" which leads me to believe that this spec is not genereated from a stable version. Possibly generated from nightly builds (not sure). Comparing the time stamps in the root swagger dist folder (https://pulsar.apache.org/swagger/), the 2.11.1 swagger folder is "2023-04-20 02:29" but the timestamp of "master" is "2023-04-18 07:43". I would expect them to be in sync if they are based on the same version.

There are quite a few inconsistencies between versioned swagger specs and the master swagger spec. One is particular is the endpoint to get a tenant's info - /admin/v2/tenants/{tenant}.

1, The pulsar admin api interface for tagged 2.11.1 is here
2. The master swagger for this endpoint is here - search for "Get the admin configuration for a given tenant"
3. The 2.11.1 swagger for this endpoint is here - search for "Get the admin configuration for a given tenant"

Compare the responses between the two versions. Notice that the master version defines a "200" with a return of "TenantInfo", but the 2.11.1 version has no "200" response.

Anything else?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@ddieruf ddieruf added the type/bug The PR fixed a bug or issue reported a bug label Apr 21, 2023
@github-actions
Copy link

The issue had no activity for 30 days, mark with Stale label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale type/bug The PR fixed a bug or issue reported a bug
Projects
None yet
Development

No branches or pull requests

1 participant