You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by MohanDV <gi...@git.apache.org> on 2017/12/11 10:29:27 UTC
[GitHub] metron pull request #862: METRON-1343: Swagger UI for User Controller needs ...
GitHub user MohanDV opened a pull request:
https://github.com/apache/metron/pull/862
METRON-1343: Swagger UI for User Controller needs request method
## Contributor Comments
Swagger UI for metron rest endpoints for User Controller has multiple requestMethods listed for the same operation as the Request method annotation is missing at UserController file.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [ ] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [ ] Have you included steps or a guide to how the change may be verified and tested manually?
- [ ] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [ ] Have you written or updated unit tests and or integration tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MohanDV/metron METRON-1343
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/862.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #862
----
commit b8e8545baf72c262a04d6d80ff51e598bd4c7ea0
Author: Mohan Venkateshaiah <mo...@gmail.com>
Date: 2017-12-11T10:01:45Z
Fixed the missing request method annotaion for the swagger UI.
----
---
[GitHub] metron pull request #862: METRON-1343: Swagger UI for User Controller needs ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/862
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by MohanDV <gi...@git.apache.org>.
Github user MohanDV commented on the issue:
https://github.com/apache/metron/pull/862
Thanks @ottobackwards . Updated the manual verification steps.
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/862
Like,
- Spin up Full Dev
- Go to Swagger at http://node1:4200(?)
- You should see X now
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/862
Please take care to mark the jira as done
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/862
Hi! Thanks for the contribution.
How can we test these changes?
Do we need new tests in the code for this change ?
Please consider the items in the PR checklist ( listed in your description ).
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/862
Great, can you list that as the manual verification please?
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by MohanDV <gi...@git.apache.org>.
Github user MohanDV commented on the issue:
https://github.com/apache/metron/pull/862
Hi @ottobackwards , we don't need new test. Currently on the Swagger UI we see that API '/api/v1/user' is listed with all the Request methods. After this fix we will see it will be listed for only GET request method. I verified by building the full dev with this change.
---
[GitHub] metron issue #862: METRON-1343: Swagger UI for User Controller needs request...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/862
+1, Thanks for the contribution!
---