Skip to content

[Doc] The rendering of REST APIs is wrong #20345

@BewareMyPower

Description

@BewareMyPower

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

For example, see https://pulsar.apache.org/docs/3.0.x/admin-api-schemas/#set-schema-compatibility-check-strategy

The original document is:

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace|operation/schemaCompatibilityStrategy?version=@pulsar:version_number@}

image

However, the website only shows GET|/admin/v2/namespaces/:tenant/:namespace. The complete URL path should be GET|/admin/v2/namespaces/:tenant/:namespace/schemaCompatibilityStrategy.

Besides, the query params are ignored as well but I think they are not important.

What is your suggestion?

We should parse the REST API after the @inject annotation with a correct way.

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Metadata

Metadata

Assignees

Labels

doc-requiredYour PR changes impact docs and you will update later.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions