docs: fix swagger tags for license endpoints #21101
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change @tags from Organizations to Enterprise for POST /licenses and POST /licenses/refresh-entitlements to match the GET and DELETE endpoints which are already tagged as Enterprise. This fixes the API docs so all license endpoints appear in the same section.
bpmct
approved these changes
Dec 4, 2025
290f1b7 to
005ab09
Compare
005ab09 to
aaca7a7
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Change
@TagsfromOrganizationstoEnterpriseforPOST /licensesandPOST /licenses/refresh-entitlementsto match theGETandDELETElicense endpoints which are already tagged asEnterprise.Problem
The license API endpoints were inconsistently tagged in the swagger annotations:
GET /licenses→Enterprise✓DELETE /licenses/{id}→Enterprise✓POST /licenses→Organizations✗POST /licenses/refresh-entitlements→Organizations✗This caused the POST endpoints to be documented in the Organizations API docs instead of the Enterprise API docs where the other license endpoints live.
Fix
Simply updated the
@Tagsannotation fromOrganizationstoEnterprisefor both POST endpoints.This was an oversight from the original swagger docs addition in #5625 (January 2023).