Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

ISSUE-20164: [Bug] Incorrect swagger specs #5735

Open
1 of 2 tasks
sijie opened this issue Apr 21, 2023 · 0 comments
Open
1 of 2 tasks

ISSUE-20164: [Bug] Incorrect swagger specs #5735

sijie opened this issue Apr 21, 2023 · 0 comments
Labels

Comments

@sijie
Copy link
Member

sijie commented Apr 21, 2023

Original Issue: apache#20164


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!
@sijie sijie added the type/bug label Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant