Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update server-plugins-api.yaml to fix query parameter #309

Merged
merged 2 commits into from
Feb 11, 2025

Conversation

kirkster96
Copy link
Contributor

Proposed changes

I am running Zowe 2.15.0 on z/OS using the .pax convivence build.

I noticed that the sample apps where already provided and fully built in the .pax

I was trying to use the Installing Plugins By REST API

I discovered that the Swagger "Try it out" wasn't working for me.
Here is a screenshot of what happened:
image

I looked into this deeper and came across this section of javascript:
https://github.com/zowe/zlux-server-framework/blob/7252bc103f09b6ae4f237fbb2412dfabfd0d8518/lib/webapp.js#L770

I believe that the request query parameter should say:

?path= ✅

instead of

?plugin%20location= ❌

I tested this from Postman and it worked!
image

I think this is a mistake in the swagger doc..

This PR addresses Issue: [Link to Github issue within https://github.com/zowe/zlux/issues if any]

This PR depends upon the following PRs:

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Change in a documentation
  • Refactor the code
  • Chore, repository cleanup, updates the dependencies.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

PR Checklist

Please delete options that are not relevant.

  • If the changes in this PR are meant for the next release / mainline, this PR targets the "staging" branch.
  • My code follows the style guidelines of this project (see: Contributing guideline)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes
  • video or image is included if visual changes are made
  • Relevant update to CHANGELOG.md
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works, or describe a test method below

Testing

Further comments

I wonder if there is a way to automatically test when the server spec matches the server implementation?

Signed-off-by: Cameron Kirk <kirkster96@gmail.com>
@kirkster96
Copy link
Contributor Author

I am also noticing that the DELETE method does not work as documented...

Here is the Swagger UI "Try it out" failing with incorrect request URL and parameters:
image

Here is the HTTP DELETE method correctly working in Postman:
image

I am not sure how to easily correct this in my Pull Request and an issue might need to be opened about this..

Copy link
Member

@1000TurquoisePogs 1000TurquoisePogs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, great spot!

@1000TurquoisePogs 1000TurquoisePogs merged commit 46c110c into zowe:v2.x/staging Feb 11, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

2 participants