[ 
https://issues.apache.org/jira/browse/METRON-503?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15828178#comment-15828178
 ] 

ASF GitHub Bot commented on METRON-503:
---------------------------------------

GitHub user merrimanr reopened a pull request:

    https://github.com/apache/incubator-metron/pull/316

    METRON-503: Metron REST API

    This pull request is the first version of the REST API.  I intentionally 
kept it simple by including only one well understood service:  CRUD interface 
for SensorParserConfigs.  While I feel it's solid (100% test coverage, 
integration tests that leverages in-memory component testing infrastructure, no 
PMD warnings, etc), there are several areas that should be reviewed:
    - Maven POM files
      - Is it consistent with other Metron components?
      - Are any plugins missing?
    - API structure
      - what should the paths look like?
    - Project structure
      - Is the code in the right place?
    - Response behavior
      - What should clients see on failures?  Should 500 codes be returned?
    
    I'm sure there are other issues I'm not thinking of.  Once we can come to a 
consensus on this initial PR, other services can be added that follow the same 
patterns we establish here.
    
    This can be tested by either running the unit/integration tests or running 
the service against a vagrant environment.  To do the latter:
    - Build the quick-dev environment
    - Run "mvn clean package" from within metron-rest
    - Start the service by running "java -jar target/metron-rest-0.2.1BETA.jar"
    - Test the REST service (running "curl 
http://localhost:8080/api/v1/sensorParserConfigs"; should return all the parser 
configs loaded during the quick-dev build)
    
    There is much more to do (deployment, packaging, etc) but this should get 
us started.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/merrimanr/incubator-metron METRON-503

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-metron/pull/316.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 #316
    
----
commit b7d310ede8785f411c9a4518207dfa3ef77983b3
Author: rmerriman <[email protected]>
Date:   2016-10-19T15:24:52Z

    Initial implementation of REST service

commit 77e79aba34e992c951ee804d918aea1e70b638ec
Author: rmerriman <[email protected]>
Date:   2016-10-19T15:31:18Z

    added newline at the end of application.yml

commit b042dfdce8e12bf320ff5dcd7b46edf68c66a302
Author: rmerriman <[email protected]>
Date:   2016-10-24T16:07:21Z

    Added logging configuration and fixed SLF4J warnings.

commit 2012369e3094dcc0d15365b914005d035e938824
Author: rmerriman <[email protected]>
Date:   2016-11-18T23:11:40Z

    Metron Docker implementation

commit d9ea03eeafb6971390899c93bad73ee00216b3f6
Author: rmerriman <[email protected]>
Date:   2016-11-18T23:19:13Z

    Cleaned up comments and added newlines to the end of files

commit b73e8084ba6c9299227bea8085d34731dabcdd88
Author: rmerriman <[email protected]>
Date:   2016-11-21T17:34:14Z

    Merge branch 'METRON-503' into middleware

commit 072f3ec7e856acdd6d565ce0c69b52fc038ec352
Author: rmerriman <[email protected]>
Date:   2016-11-28T22:18:45Z

    Merge remote-tracking branch 'mirror/master' into middleware

commit d4ff4703fcc9c84f646bf00653af43a74df3fe9d
Author: rmerriman <[email protected]>
Date:   2016-11-29T13:52:24Z

    Initial middleware commit

commit 50b4cf4aeb5a084d43a2c70d9a364dc81b7c3a42
Author: rmerriman <[email protected]>
Date:   2016-11-30T18:38:10Z

    Added start script and fixed Maven issues

commit 46d0ff32c5317f5a6c55363cac0e948893bbf755
Author: rmerriman <[email protected]>
Date:   2016-12-02T00:02:37Z

    Fixed pattern label bug

commit 53c33409916d9bfb74bb928debbe60bba18349e6
Author: rmerriman <[email protected]>
Date:   2016-12-05T18:47:08Z

    Fixes to parseMessage service.  Now writes temporary grok statement to 
local filesystem.  Also fixed some corner cases for 
sensorParserConfigHistoryService (history doesn't exist, deleting a history 
that doesn't exist, etc).  Added context path to integration tests.

commit 0a329c7ee49290d2cf31d7fed744300bf2ad2e07
Author: rmerriman <[email protected]>
Date:   2016-12-05T18:52:01Z

    Merge remote-tracking branch 'mirror/master' into docker

commit ce11ab5bcf67b051e0bbe9356d8f733de0a1ccbf
Author: rmerriman <[email protected]>
Date:   2016-12-05T18:52:59Z

    Merge branch 'docker' into middleware

commit 7db0810f76ca36b1bb9c8d98c21038175ffed117
Author: rmerriman <[email protected]>
Date:   2016-12-06T00:00:09Z

    Resolved licensing issues

commit 8825a85bfab5eaa792ea24efb1e025c90d41664b
Author: rmerriman <[email protected]>
Date:   2016-12-06T00:09:02Z

    Resolved licensing issues

commit 35240d267f1939b78991da1b3ff0210d45839299
Author: rmerriman <[email protected]>
Date:   2016-12-06T00:10:17Z

    Merge branch 'docker' into middleware

commit d38b6265b4c0806826db6f77c7c036f6115db53e
Author: rmerriman <[email protected]>
Date:   2016-12-06T00:12:38Z

    Resolved licensing issues

commit f1ce2d0ab740b9c67f4abe00e8e88d81b43dc8cd
Author: rmerriman <[email protected]>
Date:   2016-12-06T00:12:54Z

    Merge branch 'docker' into middleware

commit 25bc44e3f50f21b447d0217a2eccb4184f743c24
Author: rmerriman <[email protected]>
Date:   2016-12-06T17:10:37Z

    Updated scripts to add Hibernate and MySQL client to classpath

commit a91ce504ed0bd5bcc0fa98e77c6953f44b58bc23
Author: rmerriman <[email protected]>
Date:   2016-12-09T20:38:23Z

    Created LICENSE/NOTICE files and made small adjustment to the README.

commit c91680007c2dd71ca590b615a1dc131efb6402ae
Author: rmerriman <[email protected]>
Date:   2016-12-09T21:43:52Z

    Added license header to docker-compose.yml

commit b8ef856384a258b8a5674275526ffc56ae856938
Author: rmerriman <[email protected]>
Date:   2016-12-09T21:50:42Z

    Merge branch 'METRON-622' into middleware

commit 6be6a0ac79931c3e5e55443646db5e0234818450
Author: rmerriman <[email protected]>
Date:   2016-12-09T22:34:50Z

    Updated context paths and added assembly.xml file

commit 786aa97664fb5e2b5ab6b8ffba9ce79436c212da
Author: rmerriman <[email protected]>
Date:   2016-12-12T19:20:24Z

    Changes based on PR feedback:
    - hbase config is now read from Storm classpath instead of hbase jar
    - removed global config push from kafkazk init script
    - added license to hbase/bin/init-commands.txt
    - improved data generator script and updated documentation

commit 385bcb0821ea1f536c6dc48881eb0eff2c7f7df4
Author: rmerriman <[email protected]>
Date:   2016-12-12T20:06:19Z

    Updated flatfile_loader.sh to only depend on HBase

commit 5d86575f46b1e2b75b140a19fb088e29b55b7fd8
Author: rmerriman <[email protected]>
Date:   2016-12-12T20:15:56Z

    Fixed rest database name

commit edd4b872489fce58211add6c3baa96e0e9d2c008
Author: rmerriman <[email protected]>
Date:   2016-12-16T18:32:48Z

    Changes based on PR feedback

commit 11fa4ae1634d683f545b7d75a46a131ae8295f0f
Author: rmerriman <[email protected]>
Date:   2016-12-16T18:42:20Z

    Fixed README API links

commit 07f1a5fe209d8a29d835557a0e9a1836ed4a29ab
Author: rmerriman <[email protected]>
Date:   2016-12-19T21:05:28Z

    Changes from PR feedback.  Replaced install script with maven pom.  Also 
added more documentation.

commit bd4b81bfe459ac28324000b419d9328f82d57b87
Author: rmerriman <[email protected]>
Date:   2016-12-20T14:35:30Z

    Added commons-lang:2.4 to dependencies_with_url.csv

----


> Metron REST API
> ---------------
>
>                 Key: METRON-503
>                 URL: https://issues.apache.org/jira/browse/METRON-503
>             Project: Metron
>          Issue Type: New Feature
>            Reporter: Ryan Merriman
>            Assignee: Ryan Merriman
>         Attachments: Metron REST API.docx
>
>
> As discussed on the dev list ([DISCUSS] Metron REST API Requirements), this 
> Jira includes adding a REST API to Metron.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to