- Notifications
You must be signed in to change notification settings - Fork914
docs: fix swagger documentation for DELETE port share endpoint#18426
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+67 −22
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
The DELETE endpoint for workspace agent port shares had incorrectSwagger documentation that duplicated the GET endpoint's summaryand ID. This fixes the documentation to properly describe theDELETE operation.Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
This updates the generated API documentation to reflect the correctedSwagger annotations for the DELETE port share endpoint.Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
This updates all the markdown API documentation files to reflectthe corrected Swagger annotations for the DELETE port share endpoint.The documentation now properly shows separate sections for GET andDELETE operations with correct descriptions.Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
Try running |
matifali approved these changesJun 18, 2025
johnstcn approved these changesJun 18, 2025
98a9aa1 intomain 59 of 61 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Labels
None yet
2 participants
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.
Description
Fixes incorrect Swagger documentation for the DELETE workspace agent port share endpoint.
Problem
The DELETE endpoint at
/workspaces/{workspace}/port-sharehad duplicate Swagger documentation from the GET endpoint:@Summary Get workspace agent port shares(should be "Delete...")@ID get-workspace-agent-port-shares(should be "delete-...")This caused confusing API documentation where both endpoints appeared to have the same purpose.
Solution
Updated the DELETE endpoint's Swagger annotations to properly describe the delete operation:
@Summary Delete workspace agent port share@ID delete-workspace-agent-port-shareTesting