Skip to content

[fix][build] Fix generateOpenApiSpecs task and include missing admin v2 resources in the spec#26003

Merged
merlimat merged 2 commits into
apache:masterfrom
lhotari:lh-fix-openapi-docs-generation
Jun 11, 2026
Merged

[fix][build] Fix generateOpenApiSpecs task and include missing admin v2 resources in the spec#26003
merlimat merged 2 commits into
apache:masterfrom
lhotari:lh-fix-openapi-docs-generation

Conversation

@lhotari

@lhotari lhotari commented Jun 11, 2026

Copy link
Copy Markdown
Member

Motivation

Pulsar release process includes generating the OpenAPI spec for documentation on the Pulsar site. The generateOpenApiSpecs task is currently broken.

In addition, the admin v2 OpenAPI spec was missing recently added REST API resources: ScalableTopics (PIP-483), MetadataMigration (PIP-454) and Segments.

Modifications

  • Fix the issue by adding enforcedPlatform(project(":pulsar-dependencies")) to swaggerDeps configuration which is used for building the classpath for running the swagger tasks.
  • Include org.apache.pulsar.broker.admin.v2.ScalableTopics, org.apache.pulsar.broker.admin.v2.MetadataMigration and org.apache.pulsar.broker.admin.v2.Segments in the swaggerAdminV2 resource classes so that their endpoints are included in the generated admin v2 OpenAPI spec (swagger.json).

@lhotari lhotari added this to the 5.0.0-M1 milestone Jun 11, 2026
@lhotari lhotari added the release/blocker Indicate the PR or issue that should block the release until it gets resolved label Jun 11, 2026
@lhotari lhotari changed the title [fix][build] Fix generateOpenApiSpecs task which is used in Pulsar release process [fix][build] Fix generateOpenApiSpecs task and include missing admin v2 resources in the spec Jun 11, 2026
@merlimat merlimat merged commit e21c471 into apache:master Jun 11, 2026
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release/blocker Indicate the PR or issue that should block the release until it gets resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants