Update server-plugins-api.yaml to fix query parameter #309
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.
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.
![image](https://private-user-images.githubusercontent.com/15210279/354679749-49439f1e-9696-406d-8a50-a5a42413d7c1.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk1MzA0NzksIm5iZiI6MTczOTUzMDE3OSwicGF0aCI6Ii8xNTIxMDI3OS8zNTQ2Nzk3NDktNDk0MzlmMWUtOTY5Ni00MDZkLThhNTAtYTVhNDI0MTNkN2MxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE0VDEwNDkzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTJkMjY0YmY1NjE3NWUwZTZiYjUzZTFjOTlhMzk0OTA0OWI5MjU5M2IyMGI1MjNmYWE0M2JhODBkMTg3ZjIyOTgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.yO_pQeC8GLSSlFE7xSjTpXfMm4iRzxC0sUzMpaffyYM)
Here is a screenshot of what happened:
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](https://private-user-images.githubusercontent.com/15210279/354680421-64a6a04b-87eb-44a1-a7c1-98571847454c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk1MzA0NzksIm5iZiI6MTczOTUzMDE3OSwicGF0aCI6Ii8xNTIxMDI3OS8zNTQ2ODA0MjEtNjRhNmEwNGItODdlYi00NGExLWE3YzEtOTg1NzE4NDc0NTRjLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE0VDEwNDkzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWI3ZGM0YTVkOWI3M2QwMGYxNTljNDg3YTFhNmFhZDU5Yjk5YzY1Y2MwMDRiYTE3ZTI0ZmI5OTFlYTY5MzhiMjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.9EsJxYtGR83-nnsWed9Y3jL5xKI1MGqVL0v0awdFGUo)
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.
PR Checklist
Please delete options that are not relevant.
Testing
Further comments
I wonder if there is a way to automatically test when the server spec matches the server implementation?