GitHub user JonZeolla opened a pull request:
https://github.com/apache/metron/pull/1131
METRON-1694: Clean up Metron REST docs
## Contributor Comments
Fixes some inaccurate REST documentation. It looks like the API endpoint
anchors are still broken in the site-book, if I get a chance I'll look into
that more as well. My browser is showing some unexpected anchors when I spin
it up locally (such as `POST_.2Fapi.2Fv1.2Fpcap.2Fquery`).
## 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 documentation related changes:
- [X] 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/JonZeolla/metron METRON-1694
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1131.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 #1131
----
commit bd8d0adbaa8e53e1dc263bef194f6238abe80839
Author: Jon Zeolla <zeolla@...>
Date: 2018-07-25T15:07:43Z
METRON-1694: Clean up API docs
----
---
